跳转到主要内容
GET
curl

概述

返回一个由 vendor_data 索引的单个用户实体。响应中包含 didit_internal_id,即 Didit 的稳定内部标识符。

使用场景

  • 查询用户的当前验证状态:features 映射以单个对象的形式提供每项功能的最新状态。
  • 自有界面中的详情视图:渲染前按需获取用户资料。
  • 风险评分:结合会话计数器和 features,在您的系统中为每位用户评分。

注意事项

  • URL 中的 vendor_data 区分大小写。
  • 如果应用中不存在该 vendor_data 对应的用户,则返回 404。
  • 聚合计数器(session_count、approved_count、declined_count、in_review_count)会在会话完成时实时更新。
  • 有关每个字段的说明,请参阅用户数据模型。

权限

应用的任何处于活动状态的 API 密钥都可以调用此 endpoint。Didit 的 API 密钥是应用级别的,而非角色级别的:控制台中的角色与权限(read:users 等)决定的是人员在控制台中能做什么,对 Management API 的请求不做评估。要控制谁可以调用此 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
必填

您对该用户的唯一标识符,即自由格式字符串(非 UUID)。该值与您在首次引入该用户创建会话时作为 vendor_data 传入的值相同,按发送的内容精确匹配。

响应

完整的用户详情,包括元数据、备注/活动日志以及汇总的会话数据。

完整的用户详情。在 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日