Skip to main content
GET
curl
Returns one template. Use the biometric_template_uuid returned by Delete Session, the biometric_template_id on a Face Search match, or an id from the list.
The response never includes an image, a vector, the deleted session’s id, or identity data. See the overview for every field.

Errors

Authorizations

x-api-key
string
header
required

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

The template.

uuid
string<uuid>

Template id. Randomly generated; not derived from the deleted session or its face.

vendor_user_uuid
string<uuid>

The owning User.

vendor_data
string | null

The User's current vendor_data, resolved when you read the template (never copied).

source_type
enum<string>

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.

Available options:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

Opaque reference tying the template to its audit trail. It is not the deleted session's id and cannot be resolved to it.

retention_policy
enum<string>

The application policy at retention time.

Available options:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

The retain_face_embeddings value sent on the deletion, or null when the policy applied.

retained_at
string<date-time>
expires_at
string<date-time>

When the template expires and is purged automatically. Always set.

retained_by
string | null

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.

retained_by_type
enum<string>
Available options:
API_KEY,
CONSOLE_USER,
SYSTEM
instruction_class
enum<string>
Available options:
operational_session_delete,
privacy_erasure
instruction_source
enum<string>
Available options:
api,
console,
automatic_retention,
backfill,
privacy_erasure,
explicit_template_purge,
vendor_user_delete,
expiry,
reconciliation,
migration,
system
instruction_id
string

The instruction_id sent on the deletion, or a Didit-generated id.

held_out_of_use
boolean

true only while a legal hold applies. A held template is excluded from all matching.

status
enum<string>

Only active templates that are not held, not past expires_at, and whose User still exists take part in matching.

Available options:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null