Domain name for API request: faceid.intl.tencentcloudapi.com.
Changes the status of continuous name list screening.
A maximum of 20 requests can be initiated per second for this API.
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 | End user's unique identifier in the customer system, up to 256 characters. |
| EnableOngoingScreening | Yes | Boolean | Whether continuous monitoring screening is enabled. Default value: false. |
| 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 | Description of results returned |
| 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. |
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
}{
"Response": {
"Description": "Success"
"EnableOngoingScreening": false,
"Result": "Success",
"UniqueCustomerID": "USER_20260904_001",
"RequestId": "84f22af4-9167-4e49-9d5f-db2987116bed"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback