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

application/json
email
string<email>
erforderlich

Empfänger-E-Mail-Adresse. Ungültig formatierte Adressen geben 400 zurück; syntaktisch gültige Adressen, die keine E-Mails empfangen können (fehlgeschlagene DNS-/MX-Validierung), geben 200 mit status: "Undeliverable" zurück.

Beispiel:

"alice@example.com"

options
object

Optionen für OTP-Format, Lokalisierung und Branding. Alle Felder sind optional.

signals
object

Optionale Geräte- und Netzwerksignale über den Endbenutzer, die an die Betrugsbekämpfungsebene weitergeleitet werden, um die Erkennung von missbräuchlichem oder automatisiertem Datenverkehr zu verbessern. Alle Felder sind optional.

vendor_data
string

Optionale, vom Aufrufer gesteuerte Kennung (Ihre interne Benutzer-ID, eine E-Mail-Adresse, eine UUID usw.), die in der Sitzung gespeichert und in der Antwort auf den Sendevorgang, der Antwort auf die Abgleichprüfung, Webhooks und der Business Console zurückgegeben wird. Verwenden Sie sie, um Didits request_id mit Ihrem Benutzerdatensatz zu korrelieren.

metadata
object | null

Optionales Freiform-JSON-Objekt, das in der Sitzung gespeichert und in der Sendeantwort, der Antwort der Abgleichprüfung, in Webhooks sowie in der Business Console wiedergegeben wird.

Antwort

Versand bestätigt. Prüfen Sie status: Success und Retry bedeuten, dass ein Code unterwegs ist; Undeliverable bedeutet, dass die Adresse keine Post empfangen kann und die Verifizierung bereits als Declined abgeschlossen ist. request_id ist die gespeicherte Sitzungs-ID (dieselbe ID bei einem Retry).

request_id
string<uuid>

Sitzungs-ID der Verifizierung. Ein Retry-Sendevorgang gibt dieselbe request_id wie der ursprüngliche Sendevorgang zurück. Diese ID erscheint in der Business Console, wird von einem finalisierten POST /v3/email/check/ erneut zurückgegeben und kann an GET /v3/session/{sessionId}/decision/ übergeben werden.

status
enum<string>

Success — OTP per E-Mail an eine neue Verifizierung gesendet (abgerechnet). Retry — neuer OTP per E-Mail für die ausstehende Verifizierung gesendet, die durch einen vorherigen Versand erstellt wurde (kostenlos). Undeliverable — die Adresse hat die Zustellbarkeitsvalidierung nicht bestanden oder die Nachricht konnte nicht gesendet werden; die Verifizierung wird sofort als Declined abgeschlossen und es wird nichts abgerechnet.

Verfügbare Optionen:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered, wenn status Undeliverable ist; andernfalls null.

Verfügbare Optionen:
email_can_not_be_delivered,
null
vendor_data
string | null

Rückgabe der in der Sitzung gespeicherten vendor_data (aus dem ersten Senden).

metadata
object | null

Rückgabe der in der Sitzung gespeicherten metadata (aus dem ersten Senden).

Zuletzt geändert am 7. November 2026