Skip to main content
GET
curl

Overview

Returns a bulk session deletion started by Batch Delete Sessions: its status, how many sessions it has processed, and how many ended in each outcome. When more than 20 KYC sessions match a batch delete, selected by session_numbers or with delete_all, the request returns 202 with a PENDING job and the sessions are deleted in the background. Poll this endpoint every few seconds until status is COMPLETED or FAILED. Each session the job deletes is deleted exactly as by Delete Session: the session, every verification attempt it holds, and all of its stored files are deleted, and its media URLs stop resolving. Deletion is permanent and irreversible. The job reports counts only. It never lists which sessions it deleted.

Job status

A delete_all job deletes only the sessions created before the request. Sessions started while it runs are not deleted.

Outcome counts

deleted_child_verifications counts the verifications that deleted business verifications created and that were deleted with them. It is always 0 for a job started by Batch Delete Sessions, which deletes KYC sessions only.

Permissions

Any active API key of the application can call this endpoint. A job is only visible to the application that created it; any other job_id returns 404.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

job_id
string<uuid>
required

The job_id returned with the 202 from POST /v3/sessions/delete/.

Response

The job.

A bulk session deletion running in the background: progress and counts per outcome, never which sessions it deleted.

job_id
string<uuid>

Poll GET /v3/sessions/delete/{job_id}/ with this id.

status
enum<string>

PENDING: accepted, not started yet. PROCESSING: deleting; processed and outcomes are updating. COMPLETED: every selected session is accounted for. FAILED: the job stopped early; see error.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

Sessions selected when the deletion was requested.

processed
integer

Sessions the job has finished with so far.

outcomes
object

How many sessions ended in each outcome. Every key is always present.

deleted_child_verifications
integer

Verifications that the deleted business verifications created, deleted with them. Always 0 for a job started by POST /v3/sessions/delete/, which deletes KYC sessions only.

error
string | null

null unless status is FAILED; then why the deletion stopped. The sessions the job had not reached are still in place: repeat the request to delete them.

created_at
string<date-time>

When the deletion was requested.

completed_at
string<date-time> | null

When the job finished; null while it runs.