Zum Hauptinhalt springen
GET
curl
Gibt eine Vorlage zurück. Verwenden Sie die biometric_template_uuid aus Sitzung löschen, die biometric_template_id eines Gesichtssuche-Treffers oder eine ID aus der Liste.
Die Antwort enthält niemals ein Bild, einen Vektor, die ID der gelöschten Sitzung oder Identitätsdaten. Alle Felder finden Sie in der Übersicht.

Fehler

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Pfadparameter

template_uuid
string<uuid>
erforderlich

Template-ID, wie in biometric_template_uuid von den Endpoints zum Löschen von Sitzungen, biometric_template_id bei einem Treffer der Gesichtssuche oder dem Listen-Endpoint zurückgegeben.

Beispiel:

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

Antwort

Die Vorlage.

uuid
string<uuid>

Vorlagen-ID. Zufällig generiert; nicht aus der gelöschten Sitzung oder deren Gesicht abgeleitet.

vendor_user_uuid
string<uuid>

Der besitzende Benutzer.

vendor_data
string | null

Die aktuellen vendor_data des Benutzers, aufgelöst, wenn Sie die Vorlage lesen (werden nie kopiert).

source_type
enum<string>

Wie die Vorlage erstellt wurde: eine Sitzungslöschung (API oder Console), das automatische Datenaufbewahrungsfenster der Anwendung oder eine von Didit durchgeführte nachträgliche Datenauffüllung, die Sie beauftragt haben.

Verfügbare Optionen:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

Opake Referenz, die die Vorlage mit ihrem Audit-Log verknüpft. Sie ist nicht die ID der gelöschten Sitzung und kann nicht zu dieser aufgelöst werden.

retention_policy
enum<string>

Die Anwendungsrichtlinie zum Zeitpunkt der Datenaufbewahrung.

Verfügbare Optionen:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

Der bei der Löschung gesendete Wert retain_face_embeddings oder null, wenn die Richtlinie angewendet wurde.

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

Wann die Vorlage abläuft und automatisch bereinigt wird. Immer gesetzt.

retained_by
string | null

Prinzipal, der die Anweisung erteilt hat: die Anwendungs-ID für API-Schlüssel, die Mitglieds-ID der Console für Console-Aktionen oder eine service:-Kennung für die automatische Aufbewahrung. Niemals eine E-Mail-Adresse.

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

Die bei der Löschung gesendete instruction_id oder eine von Didit generierte ID.

held_out_of_use
boolean

true nur, solange ein Legal Hold gilt. Ein gesperrtes Template wird von jeglichem Abgleich ausgeschlossen.

status
enum<string>

Nur active Vorlagen, die nicht zurückgehalten werden, deren expires_at nicht überschritten ist und deren Benutzer noch existiert, nehmen am Abgleich teil.

Verfügbare Optionen:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
Zuletzt geändert am 7. November 2026