tencent cloud

APIs

UpdateEKYCWebhook

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-09-18 16:12:35

1. API Description

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

This API updates the 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: 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, which must use the HTTPS protocol.

3. Output Parameters

Parameter Name Type Description
WebhookId Integer

ID of the updated Webhook configuration

ModTime String

Modification time after update, 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.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック