Pular para o conteúdo principal
GET
curl
Retorna um template. Use o biometric_template_uuid retornado por Delete Session, o biometric_template_id em uma correspondência da Busca facial ou um id da lista.
A resposta nunca inclui uma imagem, um vetor, o id da sessão excluída nem dados de identidade. Consulte a visão geral para ver todos os campos.

Erros

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

template_uuid
string<uuid>
obrigatório

ID do template, conforme retornado em biometric_template_uuid pelos endpoints de exclusão de sessão, em biometric_template_id em uma correspondência da Busca facial ou pelo endpoint de listagem.

Exemplo:

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

Resposta

O modelo.

uuid
string<uuid>

ID do template. Gerado aleatoriamente; não é derivado da sessão excluída nem do rosto dela.

vendor_user_uuid
string<uuid>

O usuário proprietário.

vendor_data
string | null

O vendor_data atual do usuário, resolvido quando você lê o modelo (nunca copiado).

source_type
enum<string>

Como o modelo foi criado: uma exclusão de sessão (API ou Console), a janela automática de retenção de dados da aplicação ou um preenchimento retroativo (backfill) operado pela Didit sob sua instrução.

Opções disponíveis:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

Referência opaca que vincula o modelo à sua trilha de auditoria. Não é o id da sessão excluída e não pode ser resolvida para ele.

retention_policy
enum<string>

A política da aplicação no momento da retenção.

Opções disponíveis:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

O valor de retain_face_embeddings enviado na exclusão, ou null quando a política foi aplicada.

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

Quando o template expira e é eliminado automaticamente. Sempre definido.

retained_by
string | null

Principal que deu a instrução: o id da aplicação para chaves de API, o id do membro do Console para ações no Console, ou um identificador service: para retenção automática. Nunca um endereço de e-mail.

retained_by_type
enum<string>
Opções disponíveis:
API_KEY,
CONSOLE_USER,
SYSTEM
instruction_class
enum<string>
Opções disponíveis:
operational_session_delete,
privacy_erasure
instruction_source
enum<string>
Opções disponíveis:
api,
console,
automatic_retention,
backfill,
privacy_erasure,
explicit_template_purge,
vendor_user_delete,
expiry,
reconciliation,
migration,
system
instruction_id
string

O instruction_id enviado na exclusão, ou um id gerado pela Didit.

held_out_of_use
boolean

true apenas enquanto houver uma retenção legal. Um template retido é excluído de toda correspondência.

status
enum<string>

Somente modelos active que não estão retidos, que não ultrapassaram expires_at e cujo User ainda existe participam da correspondência.

Opções disponíveis:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
Última modificação em 1 de novembro de 2026