Saltar para o conteúdo principal
GET
curl
Devolve um template biométrico. Use o biometric_template_uuid devolvido por Delete Session, o biometric_template_id numa correspondência da Pesquisa facial, ou um id da lista.
A resposta nunca inclui uma imagem, um vetor, o id da sessão eliminada ou dados de identidade. Consulte a visão geral para ver todos os campos.

Erros

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

template_uuid
string<uuid>
obrigatório

ID do modelo, tal como devolvido em biometric_template_uuid pelos endpoints de eliminação de sessão, biometric_template_id numa correspondência da Pesquisa facial, ou pelo endpoint de listagem.

Exemplo:

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

Resposta

O modelo.

uuid
string<uuid>

ID do modelo. Gerado aleatoriamente; não derivado da sessão eliminada nem do respetivo rosto.

vendor_user_uuid
string<uuid>

O utilizador titular.

vendor_data
string | null

Os vendor_data atuais do utilizador, resolvidos quando lê o modelo (nunca copiados).

source_type
enum<string>

Como o modelo foi criado: uma eliminação de sessão (API ou Console), a janela automática de conservação de dados da aplicação ou um preenchimento retroativo operado pela Didit que tenha solicitado.

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

Referência opaca que associa o modelo ao seu registo de auditoria. Não é o id da sessão eliminada e não pode ser resolvido para o mesmo.

retention_policy
enum<string>

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

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

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

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

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

retained_by
string | null

Identidade principal que deu a instrução: o id da aplicação para chaves de API, o id do membro da consola para ações na consola 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 eliminação, ou um id gerado pela Didit.

held_out_of_use
boolean

true apenas enquanto for aplicável uma retenção legal. Um modelo retido é excluído de todas as correspondências.

status
enum<string>

Apenas os modelos active que não estejam retidos, que não tenham ultrapassado expires_at e cujo Utilizador ainda exista participam na 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 7 de novembro de 2026