code-Werten Sie Verzweigungen vornehmen können und bei welchen Fehlern Wiederholungsversuche sicher sind.
Verlassen Sie sich primär auf den Statuscode und auf code, sofern vorhanden, da sich der Text einer Nachricht ändern kann.
Statuscodes
Fehler-Bodys
Fehler-Bodys haben keine einheitliche Struktur, werten Sie sie daher defensiv aus. Der Aufbau hängt von der Endpoint-Familie ab:
Bei einem
500-Fehler wird unter Umständen gar kein JSON-Body zurückgegeben; fangen Sie daher Fälle ab, in denen der Body nicht geparst werden kann.
Fehler bei API-Schlüsseln
Für einige Minuten nach dem Löschen einer Anwendung antwortet die API mit
application_deleted, danach lehnt sie den Schlüssel wie jeden falschen Schlüssel ab.
Führen Sie keinen Wiederholungsversuch durch: Die Anwendung und ihre Schlüssel existieren nicht mehr.
Unter API-Authentifizierung und API-Schlüssel erfahren Sie, wie Schlüssel und deren Einschränkungen funktionieren.
Nicht genügend Credit
Jede API-Familie meldet ein unzureichendes Guthaben auf ihre eigene Weise:
Bei einem Vertrag antwortet das Erstellen einer Sitzung mit
403 und "code": "contract_billing_suspended", solange kostenpflichtige Dienste für Ihre Organisation pausiert sind.
Sandbox-Anwendungen werden nie abgerechnet, daher überspringen sie diese Prüfungen.
Fehlercodes
Diesecode-Werte sind stabil, sodass Sie darauf Verzweigungen aufbauen können.
Die meisten befinden sich neben detail; bei der Digital-ID-Wallet-Verifizierung ist der Code der Wert von error.
Zugriff und Abrechnung
Anfragen und Idempotenz
Bank-, Telefon- und Risikoprüfungen
Unternehmensverifizierung (KYB)
Digital-ID-Wallets
Berichte und Fälle
E-Signaturen
Bei der Sitzungserstellung treten die folgenden Dokumentprobleme als Wert des betroffenen Felds mit dem Status
400 auf, zum Beispiel {"sign": "signature_document_changed"}:
Webhooks
Wiederholungsversuche und Idempotenz
Manche Fehler können sicher wiederholt werden und manche nicht:429: Warten Sie auf denRetry-After-Header und versuchen Sie es dann erneut.502und503: Wiederholen Sie die Anfrage mit Backoff, wenn die Referenz des Endpoints besagt, dass nichts abgerechnet wurde, wie es bei Telefon-, E-Mail-, Bank- und Risikoprüfungen der Fall ist.502beiPOST /v3/database-validation/: Lesen Sie zuerst jedenvalidation_errors-Eintrag, da dieser Status allein keinen vorübergehenden Fehler bedeutet.503bei einer Löschung: Wiederholen Sie dieselbe Anfrage, bis sie200zurückgibt.- Andere
4xx: Korrigieren Sie zuerst die Anfrage, da dieselbe Anfrage auf die gleiche Weise fehlschlägt.
POST /v3/aml/ und die Digital-ID-Wallet-Verifizierung akzeptieren einen Idempotency-Key-Header mit bis zu 255 Zeichen.
Das Wiederholen einer Anfrage mit demselben Schlüssel und Payload gibt die gespeicherte Antwort erneut wieder, sodass die Verarbeitung und die Abrechnung nur einmal erfolgen.
Derselbe Schlüssel mit einer anderen Payload führt zu einer 409-Antwort, und während die erste Anfrage noch läuft, antworten die Wallet-Endpoints mit 409 und Retry-After.
POST /v3/session/ hat keinen Idempotenzschlüssel. Wenn also beim Erstellen eine Zeitüberschreitung auftritt, listen Sie Ihre Sitzungen nach vendor_data auf, bevor Sie eine weitere erstellen.
Verwandte Themen
- Rate-Limits: Limits, Header und der
429-Body. - API-Authentifizierung: So übermitteln Sie Ihren Schlüssel.
- Sandbox-Tests: Ergebnisse ohne echte Daten oder Abrechnung reproduzieren.
- Webhooks: Zustellung, Wiederholungsversuche und Reihenfolge.