跳转到主要内容
GET
curl
按时间倒序(最新的在前)检索某个列表的条目,并可选择搜索。search 会匹配条目值或标签的部分内容,且不区分大小写。reference_session_id 会将结果缩小为来自某一次验证会话的条目。在人脸列表中,metadata.face_image_source 用于标明每个条目对应会话中的哪张人脸(缺省时为 liveness)。 人脸和证件条目的 metadata 中包含图片 URL,这些 URL 在调用后很快失效。请重新获取条目以获得新的 URL,而不要存储这些 URL。未具备 media: read 权限的 API 密钥,这些 URL 将返回 null。

授权

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。

路径参数

list_uuid
string<uuid>
必填

列表的 UUID,如列出列表或创建列表所返回。

查询参数

条目的 value 或 display_label 必须包含的不区分大小写的文本。

reference_session_id
string<uuid>

仅从该人员验证会话中获取的条目,例如查看其哪些人脸已被列出。

limit
integer
默认值:50

页面大小。默认为 50。大于 1000000 的值返回 400;0、负数或非数字值将回退为 50。

必填范围: 1 <= x <= 1000000
offset
integer
默认值:0

要返回的第一项的从零开始的索引。建议跟随 next。大于 1000000 的值将返回 400;负数或非数字值将回退为 0。

必填范围: 0 <= x <= 1000000

响应

一页条目,按最新优先排序。

count
integer
必填

符合过滤条件的条目总数。

必填范围: x >= 0
next
string<uri> | null
必填

下一页的绝对 URL,最后一页则为 null。

previous
string<uri> | null
必填

上一页的绝对 URL,第一页则为 null。

results
object[]
必填
最后修改于 2026年11月7日