curl
curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.lists.entries.list(
"11111111-2222-3333-4444-555555555555",
):
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.lists.entries.list("11111111-2222-3333-4444-555555555555")) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Lists.Entries.ListAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.ListsEntriesListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.lists().entries().list("11111111-2222-3333-4444-555555555555")) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.lists.entries.list("11111111-2222-3333-4444-555555555555").auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Lists.Entries.ListAsync("11111111-2222-3333-4444-555555555555"))
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff",
"value": "X1234567",
"display_label": "Jane Doe - X1234567",
"comment": "",
"added_by": "api",
"reference_session_id": "33333333-4444-5555-6666-777777777777",
"reference_session_number": 1042,
"reference_session_type": "kyc",
"reference_object_uuid": "66666666-7777-8888-9999-000000000000",
"metadata": {
"full_name": "Jane Doe",
"issuing_state": "ESP",
"document_type": "ID",
"region": "",
"document_number": "X1234567"
},
"created_at": "2026-10-12T10:06:12.774915Z"
},
{
"uuid": "eeeeeeee-ffff-0000-1111-222222222222",
"value": "y7654321",
"display_label": "",
"comment": "Reported by a partner",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": null,
"metadata": null,
"created_at": "2026-10-03T07:48:30.552810Z"
}
]
}名单
名单条目 API:黑名单与白名单条目查询
Didit 提供 GET /v3/lists//entries/ 接口,可分页查询黑名单、白名单或自定义名单中的条目,并支持搜索过滤。按次计费。
GET
/
v3
/
lists
/
{list_uuid}
/
entries
/
curl
curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.lists.entries.list(
"11111111-2222-3333-4444-555555555555",
):
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.lists.entries.list("11111111-2222-3333-4444-555555555555")) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Lists.Entries.ListAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.ListsEntriesListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.lists().entries().list("11111111-2222-3333-4444-555555555555")) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.lists.entries.list("11111111-2222-3333-4444-555555555555").auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Lists.Entries.ListAsync("11111111-2222-3333-4444-555555555555"))
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff",
"value": "X1234567",
"display_label": "Jane Doe - X1234567",
"comment": "",
"added_by": "api",
"reference_session_id": "33333333-4444-5555-6666-777777777777",
"reference_session_number": 1042,
"reference_session_type": "kyc",
"reference_object_uuid": "66666666-7777-8888-9999-000000000000",
"metadata": {
"full_name": "Jane Doe",
"issuing_state": "ESP",
"document_type": "ID",
"region": "",
"document_number": "X1234567"
},
"created_at": "2026-10-12T10:06:12.774915Z"
},
{
"uuid": "eeeeeeee-ffff-0000-1111-222222222222",
"value": "y7654321",
"display_label": "",
"comment": "Reported by a partner",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": null,
"metadata": null,
"created_at": "2026-10-03T07:48:30.552810Z"
}
]
}
按时间倒序(最新的在前)检索某个列表的条目,并可选择搜索。
search 会匹配条目值或标签的部分内容,且不区分大小写。reference_session_id 会将结果缩小为来自某一次验证会话的条目。在人脸列表中,metadata.face_image_source 用于标明每个条目对应会话中的哪张人脸(缺省时为 liveness)。
人脸和证件条目的 metadata 中包含图片 URL,这些 URL 在调用后很快失效。请重新获取条目以获得新的 URL,而不要存储这些 URL。未具备 media: read 权限的 API 密钥,这些 URL 将返回 null。授权
您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。
路径参数
列表的 UUID,如列出列表或创建列表所返回。
查询参数
条目的 value 或 display_label 必须包含的不区分大小写的文本。
仅从该人员验证会话中获取的条目,例如查看其哪些人脸已被列出。
页面大小。默认为 50。大于 1000000 的值返回 400;0、负数或非数字值将回退为 50。
必填范围:
1 <= x <= 1000000要返回的第一项的从零开始的索引。建议跟随 next。大于 1000000 的值将返回 400;负数或非数字值将回退为 0。
必填范围:
0 <= x <= 1000000最后修改于 2026年11月7日