Zum Hauptinhalt springen
POST
cURL

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.

Body

multipart/form-data
user_image
file
erforderlich

Zu verifizierendes Live- oder Kandidaten-Gesichtsbild (z. B. ein Selfie). Reichen Sie ein einzelnes frontales Foto ein, auf dem das Gesicht der Person deutlich sichtbar und gut ausgeleuchtet ist. Zulässige Dateiendungen: tiff, jpg, jpeg, png, webp. Maximale Upload-Größe: 5 MB (größere Dateien werden mit 400 abgelehnt). Bilder werden vor der Verarbeitung automatisch auf ca. 0,5 MB komprimiert, daher verbessern sehr hohe Auflösungen die Genauigkeit nicht.

ref_image
file
erforderlich

Referenz-Gesichtsbild für den Abgleich (z. B. ein Ausweisdokument-Porträt oder ein zuvor registriertes Foto). Gleiche Format- und Größenbeschränkungen wie bei user_image.

face_match_score_decline_threshold
number<float>
Standard:30

Ähnlichkeitsschwellenwert (0–100), der den status der Antwort steuert. Ein berechneter Wert an oder unter diesem Wert setzt status auf Declined und fügt eine LOW_FACE_MATCH_SIMILARITY-Warnung hinzu; ein Wert strikt darüber gibt Approved zurück. Der Standardwert 30 ist permissiv – erhöhen Sie ihn (z. B. auf 50–60) für eine strengere Verifizierung. Werte außerhalb von 0–100 geben 400 zurück.

Erforderlicher Bereich: 0 <= x <= 100
Beispiel:

50

rotate_image
boolean
Standard:false

Wenn true, testet der Dienst die Eingabebilder in 90-Grad-Schritten (0, 90, 180, 270) und verwendet die Ausrichtung, die die beste Gesichtserkennung liefert – nützlich für mobile Aufnahmen mit fehlender EXIF-Ausrichtung. Erhöht die Latenz, aktivieren Sie dies also nur, wenn Sie aufrechte Bilder nicht garantieren können.

Beispiel:

false

save_api_request
boolean
Standard:true

Wenn true (Standard), wird der Aufruf als Sitzung vom Typ API persistent gespeichert — sichtbar in der Business Console, abrufbar über GET /v3/session/{sessionId}/decision/ unter Verwendung der zurückgegebenen request_id und angekündigt über einen status.updated-Webhook. Wenn false, wird nichts gespeichert und request_id ist eine flüchtige UUID, die nur der Antwortkorrelation dient.

Beispiel:

true

vendor_data
string

Optionale opake Zeichenfolge (Ihre interne Benutzer-ID, E-Mail, UUID…), die in der gespeicherten Sitzung hinterlegt und in der Antwort zurückgegeben wird. Verwenden Sie sie, um API-Aufrufe mit Ihren eigenen Datensätzen abzugleichen und Sitzungen später zu filtern.

Beispiel:

"user-123"

metadata
object

Optionales JSON-Objekt, das mit der Sitzung gespeichert (wenn save_api_request=true) und in der Antwort zurückgegeben wird. Senden Sie es bei Multipart-Anfragen als JSON-codiertes String-Feld (z. B. metadata={"flow":"login"}) – es wird in ein Objekt geparst.

Beispiel:

Antwort

Gesichtsabgleich wurde berechnet. face_match.score ist eine Gleitkommazahl von 0–100 (zwei Nachkommastellen); status ist Approved, wenn der Wert strikt über face_match_score_decline_threshold liegt, andernfalls Declined mit einer erläuternden Warnung. Ein Paar mit geringer Ähnlichkeit oder ohne Bewertungsmöglichkeit gibt dennoch 200 zurück – prüfen Sie face_match.status und face_match.warnings, nicht nur den HTTP-Code. Wenn save_api_request=true, ist request_id die persistierte Sitzungs-ID.

request_id
string<uuid>

Beibehaltene Sitzungs-ID, wenn save_api_request=true (verwendbar mit GET /v3/session/{sessionId}/decision/); andernfalls eine vorübergehende Korrelations-UUID.

face_match
object
vendor_data
string | null

Rückgabe der von Ihnen gesendeten vendor_data oder null.

metadata
object | null

Rückgabe des von Ihnen gesendeten metadata-Objekts oder null.

created_at
string<date-time>

ISO 8601-Zeitstempel (UTC), wann die Antwort generiert wurde, z. B. 2026-06-12T01:04:42.763237+00:00.

Zuletzt geändert am 7. November 2026