跳转到主要内容
POST
curl
一次调用即可清除多个模板。可以提供明确的 ID 列表,或提供 delete_all: true,并可选择使用与 列出生物特征模板 相同的过滤条件进一步缩小范围。

请求体

不带过滤条件的 delete_all: true 会清除应用中的所有生物特征模板,且无法撤销。请先使用相同的过滤条件运行 统计生物特征模板,确认将被清除的内容。

示例

模板逐个清除。每个结果都会报告 purged 或 already_purged。如果某个生物特征存储不可用,调用会在第一个失败的模板处返回 503。同一请求中此前已清除的模板保持清除状态,失败的模板会转为 purge_failed(已排除在匹配之外)。重复该请求即可完成剩余的清除工作。

错误

授权

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。

请求体

application/json
template_uuids
string<uuid>[]

要清理的模板。除非 delete_all 为 true,否则此项必填。已经清理过的 ID 将报告为 already_purged。

Minimum array length: 1
delete_all
boolean
默认值:false

为 true 时,清除与以下过滤器匹配的每个模板(未提供过滤器时为应用的所有模板)。template_uuids 将被忽略。不可逆。

vendor_data
string

仅适用于 delete_all:对所属用户的 vendor_data 进行不区分大小写的子字符串匹配。

vendor_user_uuid
string<uuid>

仅适用于 delete_all:与所属用户精确匹配。

status
enum<string>

仅与 delete_all 一起使用。

可用选项:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

仅与 delete_all 一起使用。

可用选项:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

仅与 delete_all 一起使用。

retained_to
string<date-time>

仅与 delete_all 一起使用。不得早于 retained_from。

响应

按模板划分的清理结果。

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