Domain name for API request: faceid.intl.tencentcloudapi.com.
This API is used to create an EKYC Webhook configuration.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateEKYCWebhook. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-01. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-hongkong, ap-singapore. |
| WebhookName | Yes | String | Webhook name, used for console display |
| WebhookURL | Yes | String | Callback URL, which must use the HTTPS protocol |
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | Returned results |
| WebhookId | Integer | ID of the created Webhook configuration |
| HasSignatureKey | Boolean | Whether to add a secret key. Default value: false. |
| SignatureKey | String | Callback secret key |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEKYCWebhook
<Common request parameters>
{
"WebhookName": "qq",
"WebhookURL": "https://www.qq.com/"
}{
"Response": {
"Result": "Success",
"WebhookId": 51,
"RequestId": "1778ad8c-2cf3-4f14-99ff-c250e32f0611"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.AMLDBError | AML database operation error. |
| FailedOperation.AMLInternalError | AML service internal error. |
| FailedOperation.AMLWebhookDuplicate | A webhook for this scene already exists. |
| FailedOperation.EKYCWebhookDuplicate | A webhook for this scene already exists. |
| InvalidParameterValue.AMLFieldValidation | Field validation failed |
| InvalidParameterValue.EKYCFieldValidation | Field validation failed. |
| InvalidParameterValue.MissingScene | Scene is required. |
| InvalidParameterValue.MissingWebhookName | WebhookName is required. |
| InvalidParameterValue.WebhookURL | Webhook URL must be a valid HTTPS URL. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback