curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.retrieve(
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.Retrieve(ctx, "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.RetrieveAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Biometric template not found."
}Obter template biométrico: API
GET /v3/biometric-templates// — Obtenha um template biométrico facial retido na Didit, com estado, validade e proveniência.
curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.retrieve(
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.Retrieve(ctx, "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.retrieve("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.RetrieveAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Biometric template not found."
}biometric_template_uuid devolvido por Delete Session, o biometric_template_id numa correspondência da Pesquisa facial, ou um id da lista.
curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
-H "x-api-key: YOUR_API_KEY"
{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
"vendor_data": "user-42",
"source_type": "session_delete",
"provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
"retention_policy": "retain_until_user_deleted",
"retention_override": null,
"retained_at": "2026-08-28T10:15:42.318402Z",
"expires_at": "2027-08-28T10:15:42.318402Z",
"retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
"retained_by_type": "API_KEY",
"instruction_class": "operational_session_delete",
"instruction_source": "api",
"instruction_id": "post-approval-cleanup-2026-08",
"held_out_of_use": false,
"status": "active",
"purged_at": null
}
Erros
| Estado | Quando | Corpo |
|---|---|---|
403 | O token de utilizador da Consola ou a chave de API não tem permissão | {"detail": "You do not have permission to perform this action."} |
404 | Template biométrico desconhecido, template biométrico de outra aplicação, ou template biométrico eliminado definitivamente | {"detail": "Biometric template not found."} |
Autorizações
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
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.
"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"
Resposta
O modelo.
ID do modelo. Gerado aleatoriamente; não derivado da sessão eliminada nem do respetivo rosto.
O utilizador titular.
Os vendor_data atuais do utilizador, resolvidos quando lê o modelo (nunca copiados).
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.
session_delete, automatic_retention, backfill 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.
A política da aplicação no momento da conservação.
delete_with_session, retain_until_user_deleted O valor de retain_face_embeddings enviado na eliminação, ou null quando a política foi aplicada.
Quando o modelo expira e é eliminado automaticamente. Sempre definido.
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.
API_KEY, CONSOLE_USER, SYSTEM operational_session_delete, privacy_erasure api, console, automatic_retention, backfill, privacy_erasure, explicit_template_purge, vendor_user_delete, expiry, reconciliation, migration, system O instruction_id enviado na eliminação, ou um id gerado pela Didit.
true apenas enquanto for aplicável uma retenção legal. Um modelo retido é excluído de todas as correspondências.
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.
pending, active, expired, held_out_of_use, purge_pending, purge_failed, purged