跳转到主要内容
GET
curl

概述

返回由 批量删除会话 发起的批量会话删除任务,包括其状态、已处理的会话数量,以及各结果类别的会话数量。 当批量删除(通过 session_numbers 选择或使用 delete_all)匹配的 KYC 会话超过 20 个时,请求将返回 202 和一个 PENDING 状态的任务,会话将在后台删除。请每隔几秒轮询此 endpoint,直到 status 变为 COMPLETED 或 FAILED。 任务删除的每个会话,删除方式都与通过 删除会话 删除会话的方式完全相同:会话本身、其持有的每次验证尝试以及其所有已存储的文件都会被删除,其媒体 URL 也将失效。删除是永久性的,且不可撤销。 任务只报告计数,从不列出具体删除了哪些会话。

任务状态

delete_all 任务只删除请求发出之前创建的会话。任务运行期间新开始的会话不会被删除。

结果计数

deleted_child_verifications 统计的是企业验证所创建的验证记录中,随企业验证一同被删除的验证数量。对于由 批量删除会话 发起的任务,该值始终为 0,因为该接口只删除 KYC 会话。

权限

应用的任何有效 API 密钥都可以调用此 endpoint。任务仅对创建它的应用可见;任何其他 job_id 都将返回 404。

相关内容

授权

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。

路径参数

job_id
string<uuid>
必填

POST /v3/sessions/delete/ 返回 202 时携带的 job_id。

响应

作业。

正在后台运行的批量会话删除:包含进度和按结果统计的数量,绝不包含其删除了哪些会话。

job_id
string<uuid>

使用此 ID 轮询 GET /v3/sessions/delete/{job_id}/。

status
enum<string>

PENDING:已接受,尚未开始。PROCESSING:正在删除;processed 和 outcomes 正在更新。COMPLETED:所有选定的会话均已处理。FAILED:任务提前停止;详见 error。

可用选项:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

请求删除时选定的会话。

processed
integer

截至目前作业已处理完成的会话。

outcomes
object

以各项结果结束的会话数量。每个键始终存在。

deleted_child_verifications
integer

已被删除的企业验证所创建的验证数,已随之一并删除。对于由 POST /v3/sessions/delete/ 启动的任务,此项始终为 0,因为该任务仅删除 KYC 会话。

error
string | null

除非 status 为 FAILED,否则为 null;若失败则表示删除停止的原因。该作业尚未处理到的会话仍保留在原处:可重复该请求以继续删除它们。

created_at
string<date-time>

请求删除的时间。

completed_at
string<date-time> | null

任务完成时间;运行中时为 null。

最后修改于 2026年11月7日