tencent cloud

APIs

DocumentaçãoAPIseKYCWebhook APIsUpdateEKYCWebhook

UpdateEKYCWebhook

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

1. API Description

Domain name for API request: faceid.intl.tencentcloudapi.com.

This API is used to update Webhook configurations.

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: UpdateEKYCWebhook.
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.
WebhookId Yes Integer

ID of the Webhook configuration to be updated
WebhookName Yes String

New Webhook name
WebhookURL Yes String

New callback URL, must be HTTPS protocol
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. We recommend using 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 over "timestamp (X-Webhook-Timestamp) + . + request body", and puts the hexadecimal result in the request header X-Webhook-Signature. The message itself is unencrypted and transmitted over HTTPS. Use the same key to recalculate and compare the signature following 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
WebhookId Integer

ID of the Webhook configuration to be updated
ModTime String

Modification time after the update, in the format YYYY-MM-DD HH:mm:ss
Result String

Returned results
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: UpdateEKYCWebhook
<Common request parameters>

{
    "WebhookId": 50,
    "WebhookName": "bbai",
    "WebhookURL": "https://www.baidu.com"
}

Output Example

{
    "Response": {
        "ModTime": "2026-05-26 10:28:46",
        "Result": "Success",
        "WebhookId": 50,
        "RequestId": "fdc74570-d799-448e-82ce-dc848c032982"
    }
}

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.
InvalidParameterValue.AMLFieldValidation Field validation failed
InvalidParameterValue.EKYCFieldValidation Field validation failed.
InvalidParameterValue.MissingWebhookName WebhookName is required.
InvalidParameterValue.WebhookURL Webhook URL must be a valid HTTPS URL.
ResourceNotFound.AMLWebhookConfig Webhook configuration not found.
ResourceNotFound.EKYCWebhookConfig Webhook configuration not found.
Anterior: CreateEKYCWebhookPróximo: DeleteEKYCWebhook

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation