Zum Hauptinhalt springen
POST
curl
Laden Sie ein base64-kodiertes Gesichtsbild in eine Gesichts-Sperrliste oder Freigabeliste hoch. Didit erkennt die Gesichter im Bild, behält das größte davon, speichert das Bild und einen Zuschnitt dieses Gesichts und berechnet das biometrische Template des Gesichts, mit dem neue Sitzungen verglichen werden. Der value des neuen Eintrags ist die UUID dieses Gesichts. Nur verfügbar für Listen mit entry_type: face und list_type: blocklist oder list_type: allowlist.
Wenn Sie ein Gesicht aus einer bestehenden Sitzung auf die Sperrliste oder Freigabeliste setzen möchten, verwenden Sie stattdessen Eintrag erstellen mit reference_session_id. Der Eintrag verweist dann auf die Sitzung.
Das Bild muss ein deutlich sichtbares Gesicht enthalten und nach der Dekodierung höchstens 2 MB groß sein. Wird kein Gesicht erkannt, gibt die Anfrage 400 zurück, und es wird kein Eintrag erstellt. Ist die Gesichtsanalyse vorübergehend nicht verfügbar, gibt sie 503 zurück: Versuchen Sie es später erneut.
Um das Gesicht von der Liste zu entfernen, löschen Sie dessen Eintrag. Es gleicht dann keine neuen Sitzungen mehr ab.

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

list_uuid
string<uuid>
erforderlich

UUID einer Liste mit entry_type: face und list_type: blocklist oder allowlist.

Body

application/json
image
string<byte>
erforderlich

Base64-kodiertes JPEG oder PNG, nach dem Dekodieren maximal 2 MB groß, das ein deutlich sichtbares Gesicht zeigt. Senden Sie die reine Base64-Zeichenfolge ohne das Präfix data:image/...;base64,.

comment
string
Standard:""

Optionale Freitextnotiz, wie beispielsweise der Grund für die Listung.

Antwort

Der Gesichtseintrag wurde erstellt.

Ein Wert in einer Liste.

uuid
string<uuid>
erforderlich

Eintrags-ID. Verwenden Sie sie als entry_uuid in „Listeneintrag löschen“.

value
string
erforderlich

Der gelistete Wert: eine Telefonnummer in E.164, eine E-Mail-Adresse, eine Dokumentennummer, eine IP-Adresse oder ein CIDR-Bereich, ein Geräte-Fingerprint, eine Wallet-Adresse, ein Bankkonto, ein Ländercode nach ISO 3166-1 Alpha-3, ein vendor_data, eine beliebige Zeichenfolge auf einer key-Liste oder die UUID des gespeicherten Gesichts auf einer Gesichtsliste. Von Ihnen gesendete Werte werden in Kleinbuchstaben gespeichert, mit Ausnahme von Telefonnummern und Ländercodes. Der Abgleich erfolgt ohne Berücksichtigung der Groß-/Kleinschreibung.

display_label
string | null
erforderlich

Lesbare Bezeichnung. Didit füllt sie für aus einer Sitzung übernommene Einträge aus (beispielsweise Name und Dokumentennummer des Inhabers), wenn Sie keine übermitteln.

Maximum string length: 512
comment
string
erforderlich

Freitext-Notiz. Leere Zeichenkette, wenn nicht festgelegt.

added_by
string | null
erforderlich

Wer den Eintrag hinzugefügt hat: api (ein API-Schlüssel), die E-Mail-Adresse eines Benutzers der Konsole oder console, system oder migration (von Didit erstellte Einträge) oder rule (eine Transaktions- oder Überwachungsregel-Aktion).

reference_session_id
string<uuid> | null
erforderlich

Verifizierungssitzung, aus der der Eintrag übernommen wurde. null, wenn der Eintrag als Wert hinzugefügt wurde.

reference_session_number
integer | null
erforderlich

Nummer dieser Sitzung innerhalb der Anwendung, wie in der Console angezeigt.

reference_session_type
enum<string> | null
erforderlich

kyc für eine Sitzung zur Personenverifizierung, kyb für eine Sitzung zur Unternehmensverifizierung, null, wenn keine Sitzung vorhanden ist.

Verfügbare Optionen:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
erforderlich

Der Datensatz, für den der Eintrag steht: der aus einer Sitzung gelesene Gesichts-, Dokumenten-, Telefon- oder E-Mail-Datensatz, das über Ein Gesicht zu einer Liste hochladen erstellte Gesicht oder die von Ihnen gesendete UUID (z. B. eine Transaktions-UUID oder die didit_internal_id eines Benutzers).

metadata
object | null
erforderlich

Zusätzlicher Kontext. Enthält die von Didit festgelegten Schlüssel (hier aufgeführt), zusammengeführt mit allen metadata, die Sie beim Erstellen des Eintrags gesendet haben, zurückgegeben wie gespeichert. null, wenn keine vorhanden sind.

created_at
string<date-time>
erforderlich

Wann der Eintrag hinzugefügt wurde.

Zuletzt geändert am 7. November 2026