Zum Hauptinhalt springen
POST
curl
Im Produktivbetrieb läuft die Kontoprüfung in Nigeria, Ghana und Kenia. Ein anderes Land wird mit 404 und code: country_not_covered beantwortet und nicht berechnet. Weitere Länder kommen nach und nach hinzu. Die Preise für Bank Verification zeigen immer, was jedes Land aktuell bietet.
Ihr Backend sendet den Namen und das Konto und liest das Ergebnis aus. Dabei handelt es sich um die Kontoprüfung des Schritts Bank Verification ohne die Person.

Das Konto so übermitteln, wie das jeweilige Land es schreibt

Manche Länder verlangen zusätzlich einen bic und bei einem Geschäftskonto eine registration_id. Leerzeichen, Bindestriche und Punkte werden ignoriert. Ein Schlüssel, den die Prüfung des Landes benötigt und nicht erhält, führt zu einem 400, das ihn benennt, zum Beispiel "field": "account.bank_code", "reason": "required". Senden Sie holder.full_name, um das Konto einer Person zu prüfen, oder holder.business_name, um das Konto eines Unternehmens zu prüfen.

Die Einwilligung des Kontoinhabers übermitteln

In manchen Ländern benötigt die Kontoprüfung vor jeder Prüfung die ausdrückliche Einwilligung des Kontoinhabers. Holen Sie sie in Ihrem Produkt ein und senden Sie dann "consent": true. Ohne sie wird eine Prüfung in diesen Ländern mit einem 400 (field: consent, reason: required) abgelehnt und nicht berechnet. Anderswo ist consent optional. Wenn Sie es senden, speichert Didit es zusammen mit den Kosten der Prüfung. Ein Sandbox-Schlüssel verlangt die Einwilligung in denselben Ländern wie ein Produktionsschlüssel.

Das Ergebnis auswerten

Abrechnung und Wiederholungen

Jede Prüfung, die die Bank beantwortet, wird einmal zum Preis der Kontoprüfung des Landes des Kontos berechnet, unabhängig vom Ergebnis. Eine Anfrage, die mit einem Fehler beantwortet wird, wird nie berechnet: ein abgelehnter Payload (400), kein Guthaben (402), ein Konto, für das noch keine Prüfung angeboten wird (404), oder eine Bank, die nicht antworten konnte (503). Es gibt keinen Idempotenz-Schlüssel und keinen Endpoint, um eine Prüfung nachträglich abzurufen. Eine wiederholte Anfrage führt eine neue Prüfung mit einer neuen request_id durch und wird erneut berechnet. Speichern Sie deshalb die Antwort. Didit speichert nur die Belastung mit der Request-ID, dem Land, dem Ergebnis und dem maskierten Konto, niemals den Namen oder die vollständige Kontonummer.

In der Sandbox testen

Ein Sandbox-API-Schlüssel ruft keine Bank auf und wird nicht berechnet. Die letzten 4 Zeichen der IBAN, andernfalls der Kontonummer, bestimmen die Antwort: Eine IBAN, eine CLABE und eine CBU enthalten Prüfziffern. Verwenden Sie deshalb die Sandbox-Werte, die jede Formatprüfung bestehen.

Zugriff

Authentifizieren Sie sich mit dem x-api-key Ihrer Anwendung oder mit deren Client-Credentials-Bearer-Token. Ein API-Schlüssel mit eingeschränkten Berechtigungen benötigt Schreibzugriff auf Sitzungen. Für den Endpoint gilt dasselbe Rate-Limit für Schreibzugriffe von 300 Anfragen pro Minute und API-Schlüssel.

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

Das Land des Kontos als ISO 3166-1 Alpha-3-Code, zum Beispiel NGA. Kleinbuchstaben werden akzeptiert.

Required string length: 3
Beispiel:

"NGA"

account
object
erforderlich

Das Konto in der Schreibweise seines Landes: eine iban oder eine account_number mit der vom Land benötigten Bank- oder Filialleitzahl (sort_code, routing_number, transit_institution, bsb, ifsc, bank_code oder bic). Mexiko verwendet eine clabe und Argentinien einen cbu_cvu, die bereits die Bank angeben. Ein Geschäftskonto fügt eine registration_id hinzu, sofern das Land eine solche verlangt. Leerzeichen, Bindestriche und Punkte werden ignoriert. Schlüssel, die von der Prüfung des Landes nicht verwendet werden, werden ignoriert; ein benötigter, aber fehlender Schlüssel führt zu einem 400, der ihn benennt.

Beispiel:
holder
object
erforderlich

Der Name, gegen den das Konto geprüft wird. Senden Sie genau eines von full_name und business_name.

vendor_data
string | null

Ihre eigene Referenz für diese Prüfung, unverändert zurückgegeben.

Beispiel:

"payout_20481"

Auf true setzen, wenn der Kontoinhaber dieser Prüfung ausdrücklich eingewilligt hat. Erforderlich in Ländern, deren Kontoprüfung diese Einwilligung verlangt: Ohne sie wird die Prüfung mit einem 400-Fehler abgelehnt, dessen field consent und dessen reason required lautet, und es wird nichts in Rechnung gestellt. Andernorts ist dies optional, und Didit erfasst dies bei der Übermittlung zusammen mit der Gebühr für die Prüfung.

Beispiel:

true

Antwort

Die Bank hat geantwortet. Die Prüfung wird abgerechnet, unabhängig vom Ergebnis.

request_id
string<uuid>
erforderlich

Die ID dieser Prüfung.

result
enum<string>
erforderlich

match: Die Bank führt das Konto unter dem von Ihnen übermittelten Namen. close_match: unter einem ähnlichen Namen, zum Beispiel ein fehlender zweiter Vorname oder ein Tippfehler. no_match: unter einem anderen Namen, oder es existiert kein solches Konto. cannot_verify: Die Bank hat geantwortet, ohne den Namen abzugleichen, zum Beispiel bei einem gesperrten oder geschlossenen Konto.

Verfügbare Optionen:
match,
close_match,
no_match,
cannot_verify
holder_name
string | null
erforderlich

Nur bei einem close_match und nur, wenn die Bank ihn zurückgegeben hat: der Name auf dem Konto, wie er bei der Bank geführt wird. Andernfalls null.

account
string
erforderlich

Das Konto, maskiert auf die letzten 4 Zeichen.

vendor_data
string | null
erforderlich

Ihre eigene Referenz, genau wie von Ihnen gesendet.

created_at
string<date-time>
erforderlich

Wann die Überprüfung durchgeführt wurde, in UTC.

Zuletzt geändert am 7. November 2026