如果 CBPay 配置了合规费用,该费用会在调用之前扣除
(你会在响应中看到
compliance_fee),并且在筛查失败时自动
退还。费用为 0 时,该服务对你免费。需要你自己的
身份验证已通过。用于构建表单的目录数据
在构建筛查(或验证)表单之前,先通过GET /v1/aml/catalogs 获取官方
目录数据:性别、公司状态、地址类型、法律实体形式(全球列表加按国家/地区级联)、
收入/财富来源、行业标准及其按国家/地区的默认值,
以及完整的 ISO-3166 国家和行政区划列表。每个条目都包含
value(发送给 API 的值)和 label(用于展示的文本)。这些是静态
数据——可以安全地缓存数小时。
城市目录(按国家/地区)
当表单需要填写城市时,在选定国家/地区后调用GET /v1/aml/catalogs/cities?country=US —— 每个国家只需调用一次,
然后在客户端按州/省筛选:
states的键与主目录中country_subdivisions的 ISO 3166-2 行政区划相同;country_cities列出无法映射到行政区划的城市 —— 也应一并提供。这两个字段永远不会是null。- 名称使用本地拼写(含重音符号 —— “Alhué”、“São Paulo”、“Ciudad de México”), 并覆盖城市辖区(comuna、区、alcaldía),选择器可以按用户熟悉的方式展示城市。
- 没有覆盖的国家/地区返回
200和空列表 —— 此时回退到自由文本的 城市字段。格式错误的代码返回400 invalid_country;未知代码返回404 country_not_found。 - 静态数据,响应带
Cache-Control: public, max-age=86400—— 可以 缓存一天。
邮政编码查询(美国)
当表单需要填写地址时,先调用GET /v1/aml/catalogs/postal-code?country=US&code=33130 解析 ZIP,
并预填城市和州/省:
- 目前仅美国 ZIP 编码(5 位数字)有数据集。返回
404 postal_code_not_found表示该 ZIP 未知 —— 或该国家/地区没有数据集 —— 地址字段保持手动填写即可。 - 请求格式错误返回
400 invalid_payload。 - 与其他目录相同的缓存策略:
Cache-Control: public, max-age=86400。
提交筛查
个人和企业使用同一个端点;类型由请求体自动识别 (账户类型之间的其他差异汇总见 个人与企业):person/company,系统会用你的账户数据自动填充
(个人/企业类型取自你的账户类型)。
尽可能发送你掌握的全部身份字段(推荐)
customer 对象接受更多可选字段,全部原样转发
给筛查引擎:发送的身份数据越多,分析越精确——出生日期、国家/地区和强身份证件
可以排除同名者,减少误报。
使用完全相同的身份数据再次查询会复用之前的
筛查结果(不再收费)。新增或更改身份字段(姓名、日期、
国家/地区、证件、别名)会使搜索更具体,并执行——同时计费——一次新的筛查。修饰性字段(邮箱、电话、文本地址)不会
影响匹配。
201 响应——个人和企业共享相同的结构;只有
compliance_service 不同(compliance_person 与 compliance_company,
各自有独立的费用):
重新筛查
对同一身份重新执行分析(例如在数据变更后,或按周期性 合规政策执行)。无需请求体——使用你上一次 筛查的customer_id:
200 响应(收取 compliance_rescreen 费用,如已配置):
409 no_screening。
持续监控
对该身份启用(或停用)持续监控——名单变化、 PEP、负面媒体。更新通过aml_screening_updated webhook 送达:
200 响应:
compliance_fee 返回 "0.000000"——停用
始终免费。
筛查 PDF 报告
历史记录中的每一条筛查都可以下载为带有你品牌的高管级 PDF 报告: 封面呈现决策及其风险信号灯、风险指标(制裁、观察名单、PEP、恐怖主义、 毒品、负面媒体、欺诈、腐败、武器)、含名单及关联关系的合并匹配、别名、 信号术语表,以及列明所查国际数据源的最终背书章节。这是你交给审计师或 交易对手作为分析证据的文档。 先在历史记录中找到screening_id:
application/pdf,带有描述性的 Content-Disposition 文件名。
lang 接受 en(默认)、es 和 zh;其他值返回
400 invalid_language。属于其他账户的 screening_id 返回 404。
报告基于筛查的持久化证据生成,即使合规引擎不可用也始终可以下载。
分析数据(名单名称、媒体标题)保留原文;仅报告的标签会被翻译。
Webhook
示例载荷:
错误
常见问题
AML 筛查与 KYC/KYB 验证有什么区别?
AML 筛查与 KYC/KYB 验证有什么区别?
筛查将身份与名单进行比对(制裁名单、PEP、负面媒体)
——不涉及证件。KYC/KYB 验证则通过表单、证件和视频
活体检测来证明个人/企业确实是其声称的身份。两者互为补充:用 KYC/KYB 验证身份,
用 AML 监控其风险。
我可以筛查我自己的客户吗?
我可以筛查我自己的客户吗?
可以:
customer 对象接受任何身份,不限于你账户本身的身份。
每次筛查都会收取相应费用(根据请求体判定为个人或企业)。筛查会改变我账户的验证状态吗?
筛查会改变我账户的验证状态吗?
不会。自 v1.34 起,你账户的
kyc_status 完全由
KYC/KYB 身份验证(你的入驻验证)管理。筛查只评估
名单风险。为什么旧的筛查不出现在历史记录中,也无法下载 PDF 报告?
为什么旧的筛查不出现在历史记录中,也无法下载 PDF 报告?
历史记录和 PDF 报告基于每次筛查的持久化证据生成,
仅覆盖历史功能上线(v1.55)之后执行的操作。更早的筛查
没有持久化证据,因此不会出现在
GET /v1/aml/screenings 中,
也无法下载报告。如需该文件,请对同一身份重新执行一次筛查
(身份数据完全相同时会复用之前的结果,不重复收费),
然后下载其报告。