Get Biometric Template
GET /v3/biometric-templates// — retrieve one retained face biometric template with its owning User, provenance, expiry, and status.
biometric_template_uuid returned by Delete Session, the biometric_template_id on a Face Search match, or an id from the list.
Errors
Authorizations
Path Parameters
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.
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"
Response
The template.
Template id. Randomly generated; not derived from the deleted session or its face.
The owning User.
The User's current vendor_data, resolved when you read the template (never copied).
How the template was created: a session deletion (API or Console), the application's automatic data-retention window, or a Didit-operated backfill you instructed.
session_delete, automatic_retention, backfill Opaque reference tying the template to its audit trail. It is not the deleted session's id and cannot be resolved to it.
The application policy at retention time.
delete_with_session, retain_until_user_deleted The retain_face_embeddings value sent on the deletion, or null when the policy applied.
When the template expires and is purged automatically. Always set.
Principal that gave the instruction: the application id for API keys, the Console member id for Console actions, or a service: identifier for automatic retention. Never an email address.
API_KEY, CONSOLE_USER, SYSTEM operational_session_delete, privacy_erasure api, console, automatic_retention, backfill, privacy_erasure, explicit_template_purge, vendor_user_delete, expiry, reconciliation, migration, system The instruction_id sent on the deletion, or a Didit-generated id.
true only while a legal hold applies. A held template is excluded from all matching.
Only active templates that are not held, not past expires_at, and whose User still exists take part in matching.
pending, active, expired, held_out_of_use, purge_pending, purge_failed, purged