扫描信息接口（已废弃）

2025-10-17 02:55

注意：该接口为旧版API，老客户仍可以继续使用。新客户请使用新版API，其参数名已标准化，简化了参数名定义的流程，使用更加便捷，详见扫描信息接口（新版）。

概览

API URL：/api/v1/aml/analyze
API 描述：该接口用于提供名单筛查扫描的结果。客户提供扫描入参后，根据不同的扫描场景和扫描逻辑，可以得到包括政治高风险人物、制裁名单、负面新闻等名单扫描的结果。

请求参数

说明：如需获取tenantID和tntInstID的详细信息，请联系ZOLOZ BD或解决方案团队。

字段名称	数据类型	最大长度	是否必填	描述	示例值
requestID	String	32B	否	请求ID，业务的唯一标识，用于追踪业务。	"39c4450e94353003a67d0d30994d****"
bizCode	String	64B	是	业务场景码，可在ZOLOZ AML Portal平台获取。	"ONBOARDING"
tenantID	String	8B	是	客户的租户ID。	"HKGYSC"
extendData	Json	1MB	是	扩展数据，该数据应包含用户想要筛查的所有字段，由用户自定义设置。	{ "userId":"12345", "name":"Jacky", "dob":"19770421", "nationality":"CN", "idNo":"123456xxx" }

返回参数

字段名称	数据类型	最大长度	描述	示例值
requestID	String	32B	请求ID，业务的唯一标识，用于追踪业务。	"39c4450e94353003a67d0d30994d****"
decision	String	64B	筛查决策。 `ACCEPT`：未命中任何名单。 `REJECT`：命中了一些名单。 `REVIEW`：疑似命中一些名单。	"REJECT"
rcrrRiskLevel	String	64B	实时客户风险等级。 `HIGH`：高风险。 `MEDIUM`：中等风险。 `LOW`：低风险。	"LOW"
hitResults	Object Array	3MB	命中详情。	-
result	Result	-	API请求结果，包含结果状态、结果码和结果消息。	{ "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" }

处理结果

根据请求结果执行下一步的响应动作，具体如下：

当result.resultStatus的值为S时，表示扫描信息接口调用成功。
当result.resultStatus的值为F时，表示扫描信息接口调用失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。

API通用结果码

有关通用结果码的完整列表，请参见API通用结果码。

API特有结果码

AML名单筛查API的结果码见下表。

结果码	结果消息	结果状态	最大长度
AML_CLEAN	No hit found.	S	32B
AML_REJECT	One or more hits are found.	S	32B
SCENARIO_ROUTE_FAILED	Failed to find existing scenarios matching the current request.	F	32B
AML_ERR_SIFT_WRONGPARAMETER	Input parameters are invalid.	F	32B
AML_ERR_SIFT_AMLSYSERROR	System error.	U	32B

代码示例

请求示例

商户服务端发送的请求代码示例。

copy
{
  "bizCode": "MANUAL_SCAN_SANCTION",
  "extendData": {
    "certName": "Peter"
  },
  "tenantID": "XXX",
  "tntInstID": "XXX"
}

说明：如需获取tenantID和tntInstID的详细信息，请联系ZOLOZ BD或解决方案团队。

返回示例

AML服务器返回的响应代码示例。

未命中名单

copy
{
  "result": {
    "resultStatus": "S",
    "resultCode": "AML_CLEAN",
    "resultMessage": "Success"
  },
  "hitResults":"",
  "requestID":"39c4450e94353003a67d0d30994d****", 
  "decision": "ACCEPT"   
}

命中了名单

copy
{
  "decision": "REJECT",
  "hitResults": [
    {
      "reason": "{\"date\":\"07-Oct-2021\",\"engineType\":\"WISE_NEXT_SANCTION\",\"hitId\":\"xxx\",\"hitType\":1,\"matchRate\":98,\"origin\":\"DOWJONES\",\"paramMatch\":\"xxx\",\"record\":{\"action\":\"add\",\"activeStatus\":\"Active\",\"addressList\":[],\"birthPlace\":[{\"name\":\"Russia\"}],\"countryDetails\":[{\"countryType\":\"Citizenship\",\"countryValueList\":[{\"code\":\"ru\"}]},{\"countryType\":\"Resident of\",\"countryValueList\":[{\"code\":\"NOTK\"}]}],\"date\":\"07-Oct-2021\",\"dateDetails\":[{\"dateType\":\"Date of Birth\",\"dateValueList\":[{\"day\":\"xx\",\"month\":\"Mar\",\"year\":\"1975\"}]}],\"deceased\":\"No\",\"gender\":\"Male\",\"groups\":[\"ALL_SANCTION_LIST\"],\"id\":\"12611176\",\"nameDetails\":[{\"nameType\":\"Primary Name\",\"nameValueList\":[{\"firstName\":\"xx\",\"middleName\":\"xx\",\"originalScriptNameList\":[\"xx\"],\"surname\":\"xx\"}]},{\"nameType\":\"Spelling Variation\",\"nameValueList\":[{\"firstName\":\"xx\",\"middleName\":\"xx\",\"surname\":\"xx\"},{\"firstName\":\"xx\",\"middleName\":\"xx\",\"surname\":\"xx\"}]}],\"origin\":\"DOWJONES\",\"originId\":\"xx\",\"sanctionsReferences\":[{\"sinceDay\":\"06\",\"sinceMonth\":\"Oct\",\"sinceYear\":\"2021\",\"value\":\"1770\"}],\"type\":\"Person\",\"version\":1},\"recordBirthDays\":[],\"recordMatch\":\"xx\",\"recordNations\":[],\"recordResCountries\":[],\"tag\":\"GROUP1.PERSON_NAME\",\"type\":\"Individual\"}",
      "scanArgs": "[{\"groupName\":\"GROUP1\",\"requestArgMap\":{\"PERSON_NAME\":\"xx xx\",\"GENDER\":\"\"},\"watchlistGroups\":[\"ALL_SANCTION_LIST\"]},{\"groupName\":\"GROUP2\",\"requestArgMap\":{},\"watchlistGroups\":[]},{\"groupName\":\"GROUP3\",\"requestArgMap\":{},\"watchlistGroups\":[]},{\"groupName\":\"GROUP4\",\"requestArgMap\":{},\"watchlistGroups\":[]}]"
    },
    {
      "reason": "{\"date\":\"24-May-2018\",\"engineType\":\"WISE_NEXT_PEP_AM\",\"hitId\":\"xxx\",\"hitType\":1,\"matchRate\":97,\"origin\":\"DOWJONES\",\"paramMatch\":\"xx\",\"record\":{\"action\":\"add\",\"activeStatus\":\"Inactive\",\"addressList\":[{\"addressCountry\":\"ve\"}],\"countryDetails\":[{\"countryType\":\"Citizenship\",\"countryValueList\":[{\"code\":\"ve\"}]},{\"countryType\":\"Resident of\",\"countryValueList\":[{\"code\":\"ve\"}]},{\"countryType\":\"Jurisdiction\",\"countryValueList\":[{\"code\":\"ve\"}]}],\"date\":\"24-May-2018\",\"dateDetails\":[{\"dateType\":\"Inactive as of (PEP)\",\"dateValueList\":[{\"day\":\"24\",\"month\":\"May\",\"year\":\"2018\"}]}],\"deceased\":\"No\",\"descriptions\":[{\"description1\":\"1\"}],\"gender\":\"Male\",\"groups\":[\"ALL_PEP\"],\"id\":\"xxx\",\"nameDetails\":[{\"nameType\":\"Primary Name\",\"nameValueList\":[{\"firstName\":\"xx\",\"middleName\":\"O.\",\"surname\":\"xx P.\"}]},{\"nameType\":\"Also Known As\",\"nameValueList\":[{\"firstName\":\"xx\",\"middleName\":\"O.\",\"surname\":\"xx\"},{\"firstName\":\"xx\",\"middleName\":\"O.\",\"surname\":\"P.\"},{\"firstName\":\"xx O.\",\"surname\":\"xx P.\"}]},{\"nameType\":\"Spelling Variation\",\"nameValueList\":[{\"firstName\":\"xx\",\"middleName\":\"O.\",\"surname\":\"xx P.\"},{\"firstName\":\"xx O.\",\"surname\":\"xx P.\"}]}],\"origin\":\"DOWJONES\",\"originId\":\"3359609\",\"roleDetail\":[{\"occTitleList\":[{\"occCat\":\"4\",\"value\":\"See Previous Roles\"}],\"roleType\":\"Primary Occupation\"},{\"occTitleList\":[{\"occCat\":\"4\",\"sinceDay\":\"08\",\"sinceMonth\":\"Sep\",\"sinceYear\":\"2014\",\"value\":\"xxx\"}],\"roleType\":\"Previous Roles\"}],\"type\":\"Person\",\"version\":1},\"recordBirthDays\":[],\"recordMatch\":\"xx P., xx O.\",\"recordNations\":[],\"recordResCountries\":[],\"tag\":\"GROUP1.PERSON_NAME\",\"type\":\"Individual\"}",
      "scanArgs": "[{\"groupName\":\"GROUP1\",\"requestArgMap\":{\"PERSON_NAME\":\"zz xx\",\"GENDER\":\"\"},\"watchlistGroups\":[\"ALL_PEP\"]},{\"groupName\":\"GROUP2\",\"requestArgMap\":{},\"watchlistGroups\":[]},{\"groupName\":\"GROUP3\",\"requestArgMap\":{},\"watchlistGroups\":[]},{\"groupName\":\"GROUP4\",\"requestArgMap\":{},\"watchlistGroups\":[]}]"
    }
  ],
  "requestID": "39c4450e94353003a67d0d30994d****",
  "result": {
    "resultCode": "AML_REJECT",
    "resultMessage": "One or more hits are found.",
    "resultStatus": "S"
  }
}