跳转到主要内容
PATCH
curl

功能说明

AML 筛查会返回一组命中结果,即与制裁名单、PEP 数据库、观察名单和负面新闻相匹配的潜在匹配项。每个命中结果都有一个 review_status(处理结果),根据匹配分数,其初始值为 Unreviewed 或 False Positive。通过此接口,您的团队(或您的自动化流程)可以记录每个命中结果的决策,且不会改变会话的整体决策。 命中结果及其 ID 可在会话决策中找到,即 AML 检查的 hits 数组。其中每个命中结果的 id 即为您在此处传递的 hit_id。 命中结果的 id 以 hit_ 开头,后跟 24 位十六进制字符,对同一主体再次筛查时保持不变。较早格式的命中结果 ID 仍可被接受,但响应中始终以当前的 id 标识该命中结果。

处理状态

审核员的决策会在持续监控的重新筛查中保留。当服务商对该实体重新筛查时,您标记为 False Positive 的命中结果会保持该状态。

更新单个命中结果

PATCH /v3/session/{sessionId}/update-aml-hit-status/
对于包含多个 AML 检查的会话(图工作流),可在 URL 中添加 ?node_id=feature_aml_1,或在请求体中包含 "node_id",以指定目标检查。

批量更新多个命中结果

PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/ 传递 hit_updates,即由 { hit_id, review_status } 组成的列表。该操作全部成功或全部失败:如果任何 hit_id 未找到,请求将返回 404,且不会更改任何命中结果。
批量调用成功后,会触发一个 data.updated Webhook,并记录一条涵盖所有变更的活动条目。

更新后会发生什么

  • Webhook:会在该会话上触发 data.updated 事件。
  • 审计记录:变更会以操作者(API 密钥或用户)的身份记录在该会话的审核记录中,并可在控制台的活动时间线中查看。
  • AML 步骤的整体状态不受影响:仅更改命中结果的处理状态,不会自行改变 AML 步骤状态或会话决策。若要更改 AML 步骤状态(Approved / Declined / In Review),请使用 update-feature-status。若要更改会话决策,请使用 update-status。

KYC 与 KYB 支持

同时适用于用户验证(KYC)和企业验证(KYB)会话,Didit 会在两类会话中解析 sessionId。对于 KYB,AML 筛查针对企业及其关键人员进行,每项 AML 检查都会展示其各自的命中结果。

权限

需要 write:sessions 权限,并使用客户端 API 密钥(x-api-key)或用户授权头进行认证。

错误

相关内容

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

路径参数

sessionId
string<uuid>
必填

验证会话的 UUID。支持用户(KYC)和企业(KYB)会话 ID,服务会跨两种会话类型解析该 ID。

示例:

"11111111-2222-3333-4444-555555555555"

查询参数

node_id
string

工作流图谱节点 ID。仅在会话包含多个 AML 检查(每个节点一个)时需要;单 AML 会话请省略。

示例:

"feature_aml_1"

请求体

application/json
hit_id
string
必填

AML 检查中 hits 数组里的命中项 id(hit_...)。以旧格式返回的命中项 id 仍被接受。

示例:

"hit_7c1e9a40b2d35f86e0a4c912"

review_status
enum<string>
必填

该命中项的新审核状态。

可用选项:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
示例:

"False Positive"

node_id
string

可选的图谱节点 ID。当会话包含多个 AML 检查时,请使用此项(在此处或作为查询参数)。

示例:

"feature_aml_1"

响应

命中项审核状态已更新。

message
string
必填

始终为 Hit status updated successfully。

hit_id
string
必填

更新后命中项的 id,按会话决策返回的形式呈现;即使请求使用的是旧格式的 id 指定该命中项,也会正常返回。

review_status
enum<string>
必填

当前存储在命中项上的审核状态。

可用选项:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
最后修改于 2026年11月7日