接口请求域名： faceid.intl.tencentcloudapi.com 。
创建EKYC Webhook配置
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEKYCWebhook。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-hongkong, ap-singapore 。 |
| WebhookName | 是 | String | Webhook 名称，用于控制台展示 |
| WebhookURL | 是 | String | 回调地址，必须为 HTTPS 协议 |
| Scene | 否 | String | 业务场景。不传默认 AML_SCREENING_RESULT_CHANGE。取值见下方枚举。 枚举值：
|
| SignatureKey | 否 | String | 回调签名密钥，最长 128 字符。用于后续回调报文的 HMAC-SHA256 验签；不传则不启用签名。建议使用OpenSSL 随机字节生成密钥，推荐命令：openssl rand -base64 32
|
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 返回结果 |
| WebhookId | Integer | 创建的 Webhook 配置 ID |
| HasSignatureKey | Boolean | 是否添加回调签名密钥 默认值：false |
| SignatureKey | String | 回调签名密钥 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEKYCWebhook
<公共请求参数>
{
"WebhookName": "qq",
"WebhookURL": "https://www.qq.com/"
}{
"Response": {
"Result": "Success",
"WebhookId": 51,
"RequestId": "1778ad8c-2cf3-4f14-99ff-c250e32f0611"
}
}云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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. |
文档反馈