跳转到主要内容
POST
curl

概述

在任何企业验证(KYB)会话开始之前,显式创建一个企业实体。

适用场景

  • 预先写入元数据(合作伙伴、等级、内部标识符),然后再发起首次企业验证(KYB)会话。
  • 迁移:从其他 KYB 供应商迁入现有企业名册。
  • 仅交易登记:为通过线下流程完成验证的企业提交交易。

注意事项

  • vendor_data 为必填项,且在每个应用内唯一。重复提交会返回冲突错误。如需更新,请使用 PATCH /v3/businesses/{vendor_data}/。
  • 基于公司登记信息的字段(legal_name、registration_number、country_code)可以预先填写,但会被首次通过的企业验证(KYB)会话中的公司登记数据覆盖。
  • 如果 country_code 与你应用的高风险国家/地区列表匹配,该企业将以 BLOCKED 状态创建。
  • 会触发 business.data.updated。

权限

角色必须具有 create:businesses 权限。

相关内容

授权

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。

请求体

application/json
vendor_data
string | null

您对此企业的唯一标识符(自由格式字符串,非 UUID)。可选但强烈建议提供。提供时,在该应用中未删除的企业之间必须唯一;按发送的内容精确匹配。

display_name
string | null

控制台中显示的易读显示名称(在界面显示时优先级高于 legal_name)。

Maximum string length: 255

企业的官方法定名称。

Maximum string length: 255
registration_number
string | null

企业注册号或成立号。

Maximum string length: 100
country_code
string | null

注册国家/地区(ISO 3166-1 alpha-2,例如 GB、US)。

Maximum string length: 10
status
enum<string>
默认值:ACTIVE

初始生命周期状态。默认为 ACTIVE。

可用选项:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

附加到企业的任意 JSON 对象。默认为 {}。

响应

企业已创建。返回完整企业记录(数据结构与获取企业相同)。

完整企业详情。在 BusinessListItem 基础上扩展了元数据和 updated_at。

didit_internal_id
string<uuid>

Didit 为此企业分配的稳定内部 UUID。

vendor_data
string | null

您对此企业的唯一标识符(创建会话时传入)。未提供供应商标识符时可为 null。

display_name
string | null

您设置的自定义显示名称

来自登记处或手动输入的官方法定名称

registration_number
string | null

企业注册号或成立号

country_code
string | null

注册国家/地区(ISO 3166-1 alpha-2,例如 GB、US)。

effective_name
string | null

最佳可用名称:如果已设置则为 display_name,否则为 legal_name

status
enum<string>

企业记录的生命周期状态(并非会话状态)。ACTIVE 为默认值,FLAGGED 标记为需要人工关注,BLOCKED 会阻止该 vendor_data 创建新会话。

可用选项:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

该企业的验证会话总数

approved_count
integer

已通过的会话数量

declined_count
integer

已拒绝的会话数量

in_review_count
integer

审核中的会话数量

features
object

该企业所有 KYB 会话的每项功能汇总状态。目前唯一的键为 KYB(公司登记核验状态)。可选值:Approved、Declined、In Review、Not Finished、Resub Requested。

features_list
object[]

与 features 相同的数据,为 {feature, status} 对象的有序数组。

last_session_at
string<date-time> | null

最近一次会话的时间戳

first_session_at
string<date-time> | null

首次会话的时间戳

last_activity_at
string<date-time> | null

最近一次活动的时间戳(状态变更、会话更新等)

tags
object[]

分配给该企业的标签

created_at
string<date-time>
metadata
object

您附加到此企业的自定义元数据 JSON。默认为 {}。

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