Skip to main content
DELETE
curl
Purges one template: it is removed from every kind of matching and the stored template is deleted. The purge is irreversible and is recorded on the audit trail with the acting principal.

Retry semantics

Didit deletes the stored template first and only then marks the template purged. If a biometric store is unavailable the call returns 503, the template moves to status: purge_failed, and it is already excluded from matching. Repeat the same call to finish the purge.

Errors

Other purge points

Templates are also purged when you delete the owning User with Batch Delete Users, when you delete any session of that User with deletion_instruction: "privacy_erasure", and automatically at expires_at. See Purge points.

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

template_uuid
string<uuid>
required

Template id, as returned in biometric_template_uuid by the session deletion endpoints, biometric_template_id on a Face Search match, or the list endpoint.

Example:

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

Response

Purge outcome.

uuid
string<uuid>
outcome
enum<string>
Available options:
purged,
already_purged