tencent cloud

APIs

UpdateAMLOngoingScreeningStatus

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-21 15:41:17

1. API Description

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

Continuous name list screening status change

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: UpdateAMLOngoingScreeningStatus.
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.
UniqueCustomerID Yes String

Unique identifier of the end user in the customer system, up to 256 characters.

EnableOngoingScreening Yes Boolean

Whether to enable continuous monitoring and screening. Default value: false

Default value: false

3. Output Parameters

Parameter Name Type Description
UniqueCustomerID String

Unique identifier of the end user in the customer system

EnableOngoingScreening Boolean

Whether continuous monitoring screening is enabled

Description String

Return result description

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: UpdateAMLOngoingScreeningStatus
<Common request parameters>

{
    "UniqueCustomerID": "USER_20260904_001",
    "EnableOngoingScreening": false
}

Output Example

{
    "Response": {
"Description": "success"
        "EnableOngoingScreening": false,
        "Result": "Success",
        "UniqueCustomerID": "USER_20260904_001",
        "RequestId": "84f22af4-9167-4e49-9d5f-db2987116bed"
    }
}

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.AMLOngoingScreeningAlreadyEnabled Ongoing screening is already enabled for this customer. No action needed.
FailedOperation.AMLOngoingScreeningSetupIncomplete Ongoing screening setup is incomplete. Please retry the screening request or contact support if the issue persists.
FailedOperation.AMLProviderError AML provider service error.
FailedOperation.AMLProviderTimeout AML provider service timeout.
FailedOperation.AMLTokenError Failed to obtain AML provider access token.
FailedOperation.CustomerNotFound Customer not found. Please check the UniqueCustomerID or call RunAMLNameScreening first.
InvalidParameterValue.AMLFieldValidation Field validation failed
InvalidParameterValue.MissingUniqueCustomerID UniqueCustomerID is required.
ResourceNotFound.AMLCustomer Customer mapping not found for the given identifier.

Ajuda e Suporte

Esta página foi útil?

comentários