Domain name for API request: faceid.intl.tencentcloudapi.com.
AML 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: UpdateAMLCustomerProfile. |
| 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. |
| EntityType | Yes | String | Entity type. Enumeration values: PERSON (individual) / COMPANY (company). |
| Person | No | Person | Personal information, required when EntityType=PERSON. Input restriction: EntityType=PERSON. |
| Company | No | Company | Enterprise information, required when EntityType=COMPANY. Input restriction: EntityType=COMPANY. |
| Parameter Name | Type | Description |
|---|---|---|
| RiskLevel | String | Risk level. |
| Result | String | Returned results |
| Description | String | Description of results returned |
| EnableOngoingScreening | Boolean | Whether continuous monitoring screening is enabled |
| 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: UpdateAMLCustomerProfile
<Common request parameters>
{
"UniqueCustomerID": "USER_20260904_004",
"EntityType": "PERSON",
"Person": {
"FullName": "John Smith",
"DateOfBirth": "1990-05-17",
"Gender": "MALE",
"Nationality": "US"
}
}{
"Response": {
"Description": "Customer profile updated successfully.",
"EnableOngoingScreening": false,
"Result": "Success",
"RiskLevel": "SKIPPED",
"RequestId": "b2027748-18a5-46bc-8247-28c04bf730ce"
}
}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.AMLInternalError | AML service internal error. |
| 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.EntityType | EntityType must be PERSON or COMPANY. |
| InvalidParameterValue.EntityTypeMismatch | EntityType does not match the existing customer record. |
| InvalidParameterValue.MissingCompany | Company data is required when EntityType is COMPANY. |
| InvalidParameterValue.MissingCompanyName | Company CompanyName is required. |
| InvalidParameterValue.MissingPerson | Person data is required when EntityType is PERSON. |
| InvalidParameterValue.MissingPersonName | Person FullName or LastName is required. |
| InvalidParameterValue.MissingUniqueCustomerID | UniqueCustomerID is required. |
| InvalidParameterValue.PersonNameConflict | When FullName is set, FirstName, MiddleName and LastName must not be set. |
피드백