跳转到主要内容
GET
curl
返回单个模板。请使用 Delete Session 返回的 biometric_template_uuid、人脸搜索匹配项 中的 biometric_template_id,或 列表 中的 ID。
响应绝不包含图片、向量、已删除会话的 ID 或身份数据。所有字段请参阅 概览。

错误

授权

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。

路径参数

template_uuid
string<uuid>
必填

模板 ID,由会话删除 endpoint 在 biometric_template_uuid 中返回、在人脸搜索匹配中通过 biometric_template_id 返回,或由列表 endpoint 返回。

示例:

"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"

响应

模板。

uuid
string<uuid>

模板 ID。随机生成;并非衍生自已删除的会话或其人脸。

vendor_user_uuid
string<uuid>

所有者用户。

vendor_data
string | null

用户的当前 vendor_data,在您读取模板时解析(绝不会被复制)。

source_type
enum<string>

模板的创建方式:会话删除(API 或 Console)、应用的数据自动保留期限,或者根据您的指示由 Didit 执行的历史回填。

可用选项:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

将模板与其审计日志关联的不透明引用。它不是已删除会话的 id,且无法解析为该 id。

retention_policy
enum<string>

在保留时间到达时适用的应用策略。

可用选项:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

删除请求中发送的 retain_face_embeddings 值,应用策略时为 null。

retained_at
string<date-time>
expires_at
string<date-time>

模板到期并被自动清除的时间。始终设置。

retained_by
string | null

发出指令的主体:API 密钥对应的应用 ID、控制台操作对应的控制台成员 ID,或自动数据保留对应的 service: 标识符。绝不为邮箱地址。

retained_by_type
enum<string>
可用选项:
API_KEY,
CONSOLE_USER,
SYSTEM
instruction_class
enum<string>
可用选项:
operational_session_delete,
privacy_erasure
instruction_source
enum<string>
可用选项:
api,
console,
automatic_retention,
backfill,
privacy_erasure,
explicit_template_purge,
vendor_user_delete,
expiry,
reconciliation,
migration,
system
instruction_id
string

删除请求中发送的 instruction_id,或由 Didit 生成的 id。

held_out_of_use
boolean

仅在法律保留生效期间为 true。处于保留状态的模板将从所有匹配中排除。

status
enum<string>

只有处于 active 状态、未被暂停、未超过 expires_at 且其用户仍然存在的模板才会参与比对。

可用选项:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
最后修改于 2026年11月7日