Saltar al contenido principal
GET
curl
Devuelve una plantilla. Usa el biometric_template_uuid que devuelve Eliminar sesión, el biometric_template_id de una coincidencia de búsqueda facial o un id de la lista.
La respuesta nunca incluye una imagen, un vector, el id de la sesión eliminada ni datos de identidad. Consulta la visión general para ver todos los campos.

Errores

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

template_uuid
string<uuid>
requerido

ID de la plantilla, tal como lo devuelven biometric_template_uuid en los endpoints de eliminación de sesiones, biometric_template_id en una coincidencia de Búsqueda facial o el endpoint de listado.

Ejemplo:

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

Respuesta

La plantilla.

uuid
string<uuid>

ID de la plantilla. Se genera aleatoriamente; no se deriva de la sesión eliminada ni de su rostro.

vendor_user_uuid
string<uuid>

El usuario propietario.

vendor_data
string | null

El vendor_data actual del usuario, que se resuelve al leer la plantilla (nunca se copia).

source_type
enum<string>

Cómo se creó la plantilla: una eliminación de sesión (API o Console), el periodo automático de retención de datos de la aplicación o un backfill realizado por Didit siguiendo tus instrucciones.

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

Referencia opaca que vincula la plantilla con su registro de auditoría. No es el id de la sesión eliminada y no puede resolverse a él.

retention_policy
enum<string>

La política de la aplicación en el momento de la retención.

Opciones disponibles:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

El valor de retain_face_embeddings enviado en la eliminación, o null cuando se aplicó la política.

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

Fecha y hora en que la plantilla expira y se purga automáticamente. Siempre está definido.

retained_by
string | null

Entidad que dio la instrucción: el id de la aplicación para las claves de API, el id del miembro de la Console para las acciones en la Console, o un identificador service: para la retención automática. Nunca es una dirección de correo electrónico.

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

El instruction_id enviado en la eliminación, o un id generado por Didit.

held_out_of_use
boolean

true solo mientras se aplica una retención legal. Una plantilla retenida queda excluida de toda búsqueda de coincidencias.

status
enum<string>

Solo participan en la búsqueda de coincidencias las plantillas active que no están retenidas, no han superado expires_at y cuyo usuario sigue existiendo.

Opciones disponibles:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
Última modificación el 1 de noviembre de 2026