tencent cloud

APIs

DocumentaçãoAPIseKYCWebhook APIsCreateEKYCWebhook

CreateEKYCWebhook

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-22 14:27:19

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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. It must use the HTTPS protocol.
Scene No String

Business scenario. Default if not passed: AML_SCREENING_RESULT_CHANGE. For parameter values, see the enumeration below.

Enumeration values:

  • AML_SCREENING_RESULT_CHANGE: AML anti-money laundering screening result change notification (default value)
  • NONDOC_VERIFICATION_RESULT: Non-document (NonDoc) verification result notification
SignatureKey No String

Callback signature key, up to 128 characters. Used for HMAC-SHA256 signature verification of subsequent callback messages. If not provided, signature is not enabled. It is recommended to use OpenSSL random bytes to generate the key. Recommended command: openssl rand -base64 32

Our side uses your configured SignatureKey to calculate the HMAC-SHA256 signature of "timestamp (X-Webhook-Timestamp) + . + request body". The result is placed in the request header X-Webhook-Signature in hexadecimal. The message itself is unencrypted and transmitted over HTTPS. Use the same key to recalculate and compare the signature according to the same rule to confirm that the notification source is trustworthy and the content has not been tampered with.

3. Output Parameters

Parameter Name Type Description
Result String

Returned results
WebhookId Integer

ID of the created Webhook configuration
HasSignatureKey Boolean

Whether to add a 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.

4. Example

Example1 Calling the API

Input Example

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/"
}

Output Example

{
    "Response": {
        "Result": "Success",
        "WebhookId": 51,
        "RequestId": "1778ad8c-2cf3-4f14-99ff-c250e32f0611"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Anterior: ListEKYCWebhooksPróximo: UpdateEKYCWebhook

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation