跳转到主要内容
PATCH
curl

概述

在 ACTIVE、FLAGGED 和 BLOCKED 之间切换用户实体的状态。完整的状态机说明请参阅实体生命周期。

何时使用

  • 阻止用户:确认存在欺诈或违反合规要求后使用。
  • 标记用户:等待人工审核期间使用,不直接阻止该用户。
  • 解除阻止:用户完成整改后使用。
  • 同步外部信号:例如,当你自己的欺诈引擎将某用户评分超过阈值时,通过此端点将其切换为 FLAGGED。

注意事项

  • 有效值为 ACTIVE、FLAGGED 和 BLOCKED。无效值将返回 400。
  • 可以传入可选的 reason(最多 1000 个字符),记录状态变更的原因。 Didit 会将其保存为该用户活动记录中状态变更条目的备注:即用户的 comments[].comment,并显示在 Business Console 的 活动 中。 仅当状态确实发生变化时才会记录。
  • BLOCKED 用户的所有新会话都将被自动拒绝,所有新交易也都将被自动拒绝。
  • 触发 user.status.updated Webhook 事件,其中包含 previous_status 和 status。 该 Webhook 不包含 reason。

执行规则

权限

主密钥和拥有完全访问权限的 API 密钥 始终可以调用此端点。 具有自定义访问权限的密钥需要 People(users)写入权限。 仅限某些工作流或已通过的会话的密钥无法访问此 endpoint。 控制台的角色与权限决定团队成员在控制台中可以执行的操作。 在 API 密钥请求中不会评估这些角色和权限。

相关内容

授权

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。

路径参数

vendor_data
string
必填

您对该用户的唯一标识符。

请求体

application/json
status
enum<string>
必填

新的生命周期状态。BLOCKED 还会将 vendor_data 添加到系统黑名单中。

可用选项:
ACTIVE,
FLAGGED,
BLOCKED
reason
string | null

状态变更的原因。仅在状态实际变更时,记录在用户活动的状态变更条目(comments[].comment,以及 Business Console 中的 Activity)上。Webhook 不包含此项。

Maximum string length: 1000

响应

用户状态已更新。返回完整用户记录。

完整的用户详情。在 UserListItem 基础上扩展了元数据、备注和 updated_at。

didit_internal_id
string<uuid>

Didit 为此用户分配的稳定内部 UUID。

vendor_data
string | null

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

display_name
string | null

您设置的自定义显示名称

full_name
string | null

从已验证证件中提取的姓名

date_of_birth
string<date> | null
effective_name
string | null

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

status
enum<string>

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

可用选项:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

用户肖像照片的预签名 URL(数小时后过期)

session_count
integer

该用户的验证会话总数

approved_count
integer

已通过的会话数量

declined_count
integer

已拒绝的会话数量

in_review_count
integer

审核中的会话数量

issuing_states
string[]

此用户已通过的身份证件上显示的签发国家/地区的 ISO 3166-1 alpha-3 代码,例如 ["USA", "ESP"]。无时为空数组。

approved_emails
string[]

从该用户已通过的会话中收集的已验证邮箱地址,例如 ["john@example.com"]。

approved_phones
string[]

从该用户已通过的会话中收集的已验证电话号码,例如 ["+14155551234"]。

features
object

该用户所有会话的每项功能汇总状态。可选键:ID_VERIFICATION、NFC、LIVENESS、FACE_MATCH、POA、QUESTIONNAIRE、EMAIL_VERIFICATION、PHONE、AML、IP_ANALYSIS、AGE_ESTIMATION、DATABASE_VALIDATION。可选值: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[]

标签分配情况。注意:与列表响应中使用的扁平 {uuid, name, color} 结构不同,详情响应中的每个条目均为标签链接对象({uuid, tag: {...}, added_by_email, added_by_name, created_at})。

created_at
string<date-time>
metadata
object

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

comments
object[]

该用户的活动日志和评论(状态变更、资料修改、手动备注)。

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