Zum Hauptinhalt springen
POST
curl

Ihren Markennamen in der SMS angeben

SMS-Codes enthalten den SMS-Absendernamen Ihrer Anwendung, den Sie in der Business Console festlegen. Dafür fallen keine zusätzlichen Kosten an:
123456 ist Ihr Verifizierungscode für Acme Bank
Um einen Code mit einem anderen Namen zu versehen, übergeben Sie options.sms_sender_name (1 bis 30 Zeichen: nur Buchstaben, Ziffern, Leerzeichen sowie ’ & - !, nicht ausschließlich Ziffern):
Ein Name, der diese Regeln nicht erfüllt, führt zu 400, und es wird kein Code gesendet. WhatsApp-Codes verwenden eine feste Nachricht und sind nicht markenspezifisch. Verbinden Sie Ihre eigene WhatsApp-Business-Nummer in der Business Console, um sie unter Ihrem Geschäftsnamen zu versenden. Siehe WhatsApp-Codes von Ihrer eigenen Nummer senden. Welchen Namen ein Code trägt und wie hoch das tägliche Limit für neue Namen ist, erfahren Sie unter Markenspezifische Verifizierungsnachrichten.

Ausfälle des Anbieters behandeln

Wenn der Telefonanbieter vorübergehend nicht verfügbar ist, gibt dieser Endpoint 502 mit einem stabilen, maschinenlesbaren Code zurück:
Behandeln Sie diese Antwort als für einen Wiederholungsversuch geeignet. Verwenden Sie eine kurze Wartezeit (Backoff) und zeigen Sie dem Benutzer eine Meldung über eine vorübergehende Nichtverfügbarkeit des Dienstes an, statt ihn aufzufordern, eine gültige Telefonnummer oder einen gültigen Code zu ändern.

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
phone_number
string
erforderlich

Telefonnummer des Empfängers im E.164-Format – vorangestelltes + und Ländervorwahl (z. B. +14155552671). Nummern werden validiert und in E.164 normalisiert; nicht analysierbare oder ungültige Nummern geben 400 mit einem phone_number-Feldfehler zurück.

Maximum string length: 20
Beispiel:

"+14155552671"

options
object

Optionen für die OTP-Zustellung. 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; Blocked bedeutet, dass die Anti-Betrugs-Ebene abgelehnt hat 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/phone/check/ erneut zurückgegeben und kann an GET /v3/session/{sessionId}/decision/ übergeben werden.

status
enum<string>

Success — OTP an eine neue Verifizierung gesendet. Retry — OTP für die ausstehende Verifizierung erneut gesendet, die durch einen vorherigen Versand erstellt wurde. Blocked — die Anti-Fraud-Schicht hat das Senden verweigert; die Verifizierung wird sofort als Declined abgeschlossen und es wird nichts abgerechnet.

Verfügbare Optionen:
Success,
Retry,
Blocked
reason
string | null

Warum ein Versand den Status Blocked hatte (z. B. repeated_attempts, suspicious, spam). null bei Success und Retry.

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