接口请求域名: faceid.intl.tencentcloudapi.com 。
AML 名单筛查
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateAMLCustomerProfile。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-hongkong, ap-singapore 。 |
| UniqueCustomerID | 是 | String | 客户系统中终端用户的唯一标识,最长 256 字符。 |
| EntityType | 是 | String | 实体类型,枚举值:PERSON / COMPANY 枚举值:
|
| Person | 否 | Person | 个人信息,EntityType=PERSON 时必填 入参限制:EntityType=PERSON |
| Company | 否 | Company | 企业信息,EntityType=COMPANY 时必填 入参限制:EntityType=COMPANY |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RiskLevel | String | 风险等级 |
| Result | String | 返回结果 |
| Description | String | 返回结果描述 |
| EnableOngoingScreening | Boolean | 是否开启持续监控筛查 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAMLCustomerProfile
<公共请求参数>
{
"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"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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. |
文档反馈