跳转到主要内容
PATCH
Python

授权

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>
必填

企业验证(KYB)会话的 UUID。它必须属于 API 密钥所属的应用。

示例:

"33333333-4444-5555-6666-777777777777"

draftId
string<uuid>
必填

参与方草稿的 UUID(创建时返回的 draft_id)。

示例:

"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d"

查询参数

node_id
string

KYB 步骤的工作流节点。仅在工作流具有多个 KYB 节点时需要;默认情况下,Didit 会使用会话自身的节点。

请求体

application/json

参与方字段的任意子集。编辑内容将合并到已存储的草稿中,合并后的参与方会作为整体进行验证,因此编辑前能够提交的草稿在编辑后依然可以提交。

entity_type
enum<string>

该主体是个人还是公司。

可用选项:
person,
company
full_name
string

个人的姓名。发送此字段,或者发送 first_name 和 last_name。

Maximum string length: 255
first_name
string
Maximum string length: 128
last_name
string
Maximum string length: 128
role
enum<string>

当事方持有的角色。可与 roles 互换;两者都发送时将被合并。

可用选项:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
roles
enum<string>[]

该主体拥有的每个角色。人员至少需要一个角色(在此处或在 role 中)。

可用选项:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

个人的职位头衔。

Maximum string length: 128
date_of_birth
string<date> | null
company_name
string

企业相关方的名称。当 entity_type 为 company 时必填。

Maximum string length: 255
registration_number
string

企业关联方的注册号。

Maximum string length: 100
email
string<email>

验证链接发送到的位置。当当事方必须完成验证时为必填项,这取决于工作流的角色设置和股权结构阈值。

ownership_percent
number | null

该方拥有的公司股份比例。

nationality
string

个人的国籍,或企业的注册国家/地区。每个当事方都必须提供此信息。

Maximum string length: 100
phone_number
string
Maximum string length: 32
custom_fields
object

工作流定义的附加字段。

skip_verification
boolean
默认值:false

请求跳过此主体的验证。仅当主体的角色在工作流的“关键人员”设置中允许跳过时才有效。

响应

草稿已更新。

draft_id
string<uuid>
必填
created_at
string<date-time>
必填
updated_at
string<date-time>
必填
party
object
必填
最后修改于 2026年11月7日