跳转到主要内容
POST
curl

授权

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。

请求头

Idempotency-Key
string

可选的重试安全密钥,最多 255 个字符。使用相同的请求体复用同一密钥将返回原始响应,而不会执行第二次筛查或重复计费。使用不同的请求体复用该密钥将返回 409。

Maximum string length: 255

请求体

application/json
full_name
string
必填

待筛查个人或企业的姓名。最少 2 个字符,此为筛查服务商自身的最低限制。在执行任何筛查之前,较短或空白的名称会使该字段返回 400,因此不会产生任何计费。

Minimum string length: 2
示例:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
默认值:person

要筛查的实体类型。默认为 person。

可用选项:
person,
company
date_of_birth
string<date>

出生日期(自然人)或成立日期(企业),YYYY-MM-DD。通过出生日期权重提高匹配精度。

示例:

"1972-02-29"

nationality
string

ISO 3166-1 alpha-2 国家/地区代码(例如 ES)。无效代码返回 400。通过国家/地区权重提高匹配精度。

示例:

"ES"

document_number
string

身份证件号码。不设权重 — 充当黄金密钥:完全匹配会将命中的 match_score 覆盖为 100,严重不匹配则会对其进行惩罚扣分。仅当长度为 2-50 个字符时,才会作为搜索过滤器发送给筛查提供商;超出该范围的值会被接受并存储,筛查仍会运行并计费,只是不会按证件号码缩小范围。

aml_score_approve_threshold
number
默认值:80

判定结果为 Approved 的风险评分阈值(小于或等于该值)。必须 ≤ aml_score_review_threshold(否则返回 400)。

必填范围: 0 <= x <= 100
aml_score_review_threshold
number
默认值:100

判定结果为 Declined 的风险评分阈值上限。介于两个阈值之间的分数将产生 In Review。

必填范围: 0 <= x <= 100
aml_name_weight
integer
默认值:60

姓名相似度在单次命中匹配分数中的权重。这三个权重相加必须正好为 100(否则返回 400)。

必填范围: 0 <= x <= 100
aml_dob_weight
integer
默认值:25

出生日期在单次命中匹配分数中的权重。

必填范围: 0 <= x <= 100
aml_country_weight
integer
默认值:15

国家/地区/国籍在单次命中匹配分数中的权重。

必填范围: 0 <= x <= 100
aml_match_score_threshold
integer
默认值:93

逐条命中的截断阈值:match_score 低于此值的命中标注为 False Positive(不计入风险评估);等于或高于此值的为 Unreviewed 疑似匹配项。

必填范围: 0 <= x <= 100
include_adverse_media
boolean
默认值:false

同时在新闻媒体中搜索负面报道。汇总结果时最多增加约 30 秒延迟 — 请使用 ≥60 秒的客户端超时时间。

include_ongoing_monitoring
boolean
默认值:false

持续对此档案重新筛查并通过 Webhook 推送变更。需要 save_api_request=true(否则返回 400)。

save_api_request
boolean
默认值:true

将筛查持久化为会话(控制台可见性、决策 endpoint、Webhook、命中审核)。设为 false 则执行无状态检查。

vendor_data
string

您为被筛查用户指定的标识符;将原样返回并与会话一起存储。

metadata
object | null

随请求一同存储并回显的自由格式 JSON。

sandbox_scenario
string

仅限沙盒的场景标识(slug)。仅在 API 密钥属于沙盒模式应用时被接受;在生产环境应用上会被拒绝。独立筛查没有需要配置的会话,因此 slug 直接置于筛查请求本身:decline_aml_hit 返回一个具有生产环境格式的命中并将筛查判定为 Declined,review_aml_possible_match 将其判定为 In Review,而不触发 AML 结果的场景将使筛查保持无命中。请参阅 GET /v1/sandbox/scenarios/ 中的场景目录或沙盒与测试数据。

示例:

"decline_aml_hit"

响应

筛查已完成。aml.status 反映您的阈值设置;达到或高于内部收录下限的每个命中项都会列在 aml.hits 中,并带有其身份 match_score、实体 risk_score 以及解释匹配原因的 score_breakdown。

request_id
string<uuid>

当 save_api_request=true 时持久化的会话 ID(可用于 GET /v3/session/{sessionId}/decision/);否则为一个临时的关联 UUID。

aml
object
vendor_data
string | null

回显您发送的 vendor_data。

metadata
object | null

您发送的 metadata 回显。

created_at
string<date-time>
最后修改于 2026年11月7日