跳转到主要内容
POST
Python
请发送与您计划用于欺诈检查的请求体相同的内容。 规划操作不会创建检查或会话,不调用数据补充供应商,不读取网络历史记录,也不收取任何费用。 每个模块都将 available 与 will_run 区分开来。 availability_reason 说明所提供的输入是否支持该模块,selection_reason 则说明该模块为何被选中或未被选中。 请让不可用的开关保持可见,并显示其输入要求。 networks_cross_org 需要 Enterprise 套餐,且您组织的共享模式需设为 global。 若未满足这些条件,或您的组织未启用 Networks,规划结果会以 available: false 和 availability_reason: "entitlement_required" 报告该情况。 选择该模块的检查会以相同原因跳过它。 沙盒应用不受套餐或共享模式限制:只要提供受支持的标识符,该模块即可运行,并返回空的示例结果。 estimated_price 是以返回的 currency 为单位的十进制字符串。 价格为 null 表示不可用或未定价,而非免费。 顶层估算金额汇总所选的可运行模块;can_afford 还会检查适用的计费方式。 更改标识符、上下文或选择后,请重新规划。 执行时会重新检查资格和价格,因此规划结果既不是预留,也不保证外部数据源会作出响应。

授权

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。

请求体

subject
object
必填
client_reference
string

您为此项检查指定的自身参考编号。同时充当幂等性密钥:使用相同的请求体复用该编号将返回原始检查结果,而不会再次运行模块或计费;使用不同的请求体复用该编号将返回 409。

Required string length: 1 - 255
profile
string
默认值:standard

编排配置文件 ID。默认为 Didit 的 standard 配置文件。

Required string length: 1 - 64
profile_version
string

固定冻结的档案版本。默认为档案的当前版本。

Required string length: 1 - 32
context
object
checks
object
vendor_data
string
Maximum string length: 1000
metadata
any

响应

profile_id
string
必填
profile_version
string
必填
modules
object[]
必填
estimated_price
string | null
必填
currency
string | null
必填
is_sandbox
boolean
必填
can_afford
boolean
必填
最后修改于 2026年11月7日