跳转到主要内容
GET
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。

路径参数

settings_uuid
string<uuid>
必填

工作流每个版本对应的 UUID(列表 endpoint 返回的 uuid 值)。工作流的每个版本都有其自己的 settings_uuid。

响应

完整的工作流配置。其结构为原始的 VerificationSettings 序列化结果(约 190 个字段:涵盖每个功能开关、阈值、警告操作、允许证件配置、workflow_graph、重试策略、回调以及定价)。以下示例已简化。注意事项:features 为用 " + " 连接的字符串(例如 "OCR + LIVENESS"),价格为 JSON 数字,且仅对于 draft 版本 is_editable 为 true。

以下字段均为类型化字段;该对象还包含工作流配置的每个其他列(功能开关、阈值、警告操作、允许的证件、回调)作为附加属性。不适用于该 workflow_type 的字段为 null。

uuid
string<uuid>

每个版本对应的标识符(settings_uuid)。工作流的每个版本都有其独有的标识符。

workflow_id
string<uuid>

工作流所有版本共享的稳定标识符。使用它创建的会话将采用最新发布的版本。

workflow_label
string

工作流的显示名称。

workflow_type
enum<string> | null

工作流模板。对于未使用模板创建的图谱工作流为 null。

可用选项:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

这是否为该应用的默认工作流。

is_archived
boolean

已归档的工作流无法启动新会话。

version
integer

工作流内的版本号。

status
enum<string>

草稿版本可编辑;已发布版本不可更改,并用于新会话。

可用选项:
draft,
published
published_at
string<date-time> | null

此版本发布的时间。草稿为 null。

is_simple_workflow
boolean

当工作流没有自定义 workflow_graph 时为 true。

is_editable
boolean

仅对 draft 版本为 true。

workflow_url
string<uri>

启动此工作流会话的公开 URL。

workflow_graph
object | null

工作流的图谱结构(节点和边)。简单工作流为 null。

features
string

用 " + " 连接的已启用功能,例如 "OCR + LIVENESS"。

total_price
number | null

每次会话的价格;对于图谱工作流,为最昂贵路径的价格。

min_price
number | null

工作流中最便宜路径的价格。

max_price
number | null

工作流中最昂贵路径的价格。

special_add_on_prices
object | null

特定于组织的附加项价格,未设置时为 null。

max_retry_attempts
integer

验证被拒绝后允许的重试次数。

retry_window_days
integer | null

允许重试的天数。

session_expiration_time
integer

未完成会话过期前的秒数。

questionnaire
object | null

附加到工作流的问卷,或为 null。

kyb_role_settings
object[]

针对 KYB 关键人员的按角色验证设置。

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

当前哪些电子签名等级可以签署。在设置 signature_level 之前请检查此项。在 kyc、kyb 和图谱工作流中返回。

is_bank_verification_enabled
boolean

简易 KYC 或 KYB 工作流是否运行银行验证。它在联系方式步骤(以及位置验证)之后、数据库核验、AML 及 IP 分析之前运行。银行验证目前尚未正式公开发布:在未启用的情况下开启将被拒绝。

bank_verification_config
object

简单工作流的银行验证设置,包含与 BANK_VERIFICATION 节点相同的键(例如 bank_countries 和 bank_method_order)。未知键将被丢弃。每个键均为可选,缺少的键保持其默认值,因此 {} 表示全部使用默认值。参见银行验证设置。

示例:
is_geolocation_enabled
boolean

简易 KYC 工作流是否运行位置验证。它在联系方式步骤之后、银行验证和数据库核验之前运行。企业(KYB)工作流无法运行该验证。

geolocation_config
object

简易工作流的位置验证设置,具有与 GEOLOCATION 节点相同的键(例如 is_geolocation_geofencing_enabled 和 geolocation_max_attempts)。未知的键将被丢弃。每个键都是可选的,缺少的键保持其默认值,因此 {} 表示全部使用默认值。

示例:
最后修改于 2026年11月7日