Saltar al contingut principal
GET
curl
Retorna una plantilla. Utilitza el biometric_template_uuid que retorna Delete Session, el biometric_template_id d’una coincidència de Cerca facial, o un id de la llista.
La resposta mai no inclou cap imatge, cap vector, l’id de la sessió eliminada ni dades d’identitat. Consulta la visió general per a tots els camps.

Errors

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

template_uuid
string<uuid>
requerit

ID de la plantilla, tal com es retorna a biometric_template_uuid pels endpoints de supressió de sessions, biometric_template_id en una coincidència de cerca facial o l'endpoint de llistat.

Exemple:

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

Resposta

La plantilla.

uuid
string<uuid>

ID de la plantilla. Generat aleatòriament; no es deriva de la sessió suprimida ni de la seva cara.

vendor_user_uuid
string<uuid>

L'usuari propietari.

vendor_data
string | null

El vendor_data actual de l'usuari, resolt en llegir la plantilla (mai es copia).

source_type
enum<string>

Com es va crear la plantilla: una supressió de sessió (API o Console), la finestra automàtica de conservació de dades de l'aplicació o un emplenament retroactiu operat per Didit segons les teves instruccions.

Opcions disponibles:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

Referència opaca que vincula la plantilla al seu registre d'auditoria. No és l'id de la sessió suprimida i no es pot utilitzar per resoldre'l.

retention_policy
enum<string>

La política de l'aplicació en el moment de la conservació.

Opcions disponibles:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

El valor retain_face_embeddings enviat en la supressió, o null si s'ha aplicat la política.

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

Quan la plantilla caduca i es purga automàticament. Sempre definit.

retained_by
string | null

Identitat principal que ha donat la instrucció: l'id de l'aplicació per a claus d'API, l'id de membre de la Console per a accions de la Console o un identificador service: per a la conservació automàtica. Mai una adreça de correu electrònic.

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

L'instruction_id enviat en la supressió, o un id generat per Didit.

held_out_of_use
boolean

true només mentre s'aplica una retenció legal. Una plantilla retinguda s'exclou de totes les coincidències.

status
enum<string>

Només les plantilles active que no estiguin retingudes, no hagin superat expires_at i l'usuari de les quals encara existeixi participen en la coincidència.

Opcions disponibles:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
Darrera modificació el 7 de novembre del 2026