API-Antwortcodes — Vollständige Referenz

Diese Seite ist eine vollständige Referenz für alle von den DQE-APIs zurückgegebenen Antwortcodes — sowohl HTTP-Fehler als auch dienstspezifische Validierungscodes. Verwenden Sie die folgenden Abschnitte, um jeden erhaltenen Code nachzuschlagen.

• HTTP-Fehler — gemeinsam für alle APIs
• Email API
• Phone API
• Address API — CheckAddress (DQECodeDetail)
• Geocoding API (CodeQualiteGeo)
• B2B API
• SMS Phone Confirmation API
• ID Mobile API

HTTP-Fehler — gemeinsam für alle APIs

Diese Fehler treten auf der HTTP-Transportebene auf und sind allen DQE-API-Diensten gemeinsam.

Classic-APIs

Restful-APIs

Restful-APIs geben strukturierte JSON-Fehlerobjekte im folgenden Format zurück:

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Licence",
  "error": "bad request"
}

Email API

Wird zurückgegeben von Email API — Eine E-Mail-Adresse validieren (Classic) und Restful Email API — email/lookup.

IdError-Codes

Das Feld IdError ist das primäre Validierungsergebnis für jede E-Mail-Anfrage.

CodeActivite-Codes (Stufe-2-Prüfung)

Wird nur zurückgegeben, wenn die Stufe-2-Prüfung aktiviert ist. M = aktueller Monat.

Phone API

Wird zurückgegeben von Phone API — Classic und Restful Phone API — phonelookup.

IdError-Codes

Statuscodes (Stufe-2-Prüfung — Classic API)

Wird zurückgegeben, wenn Status=Y in der Anfrage gesetzt ist. Nur für französische Mobilfunknummern.

Address API — CheckAddress (DQECodeDetail)

Wird zurückgegeben von Address API — Check and verify an address (Classic) und Address API — Check and verify an address (RESTful). Das Feld DQECodeDetail (Classic) / DQEDetailCode (RESTful) gibt den Qualitätswert der Adressvalidierung an. Die empfohlenen UI-Meldungen stammen aus dem Address API — Integrationsleitfaden.

Kurzanleitung zur Interpretation: Codes 10, 20, 25 = Adresse ist gültig. Code 90 = internationale Adresse, Ländercode stimmt nicht überein — bitte überprüfen. Codes 21–24 = Problem mit der Hausnummer. Codes 30–61 = Problem mit der Straße (ohne die veralteten 40/60). Code 70 = Postleitzahl/Stadt stimmen nicht überein, Straße vorhanden. Code 80 = Postleitzahl/Stadt stimmen nicht überein, Straße fehlt. Code 81 = leere Eingabe. Code 95 = falsches Land. Die Codes 40, 60, 71 sind veraltet — nur aus Kompatibilitätsgründen beibehalten.

Geocoding API (CodeQualiteGeo)

Wird zurückgegeben von Geocoding API — GPS-Koordinaten abrufen und von CheckAddress, wenn Version=1.1. Das Feld CodeQualiteGeo gibt die Genauigkeitsstufe der Geokoordinaten an.

Hinweis: Wenn Licence fehlt oder ungültig ist, gibt die Geocoding API Latitude: "0.00" und Longitude: "0.00" zurück, anstatt einen HTTP-Fehler.

B2B API

Wird zurückgegeben von B2B Classic API — RECSIRET, B2B Classic API — SIRETINFO, Restful B2B API — Lookup und Restful B2B API — GetInfo.

DQE_status (Classic API — SIRETINFO, erweiterte Form)

CompanyStatus

MainCompanyFlag

SMS Phone Confirmation API

Wird zurückgegeben von SMS Phone Confirmation API — Send OTP (GDPR_MSG) und SMS Phone Confirmation API — Verify OTP (GDPR_VERIF).

GDPR_MSG — SMS-Zustellstatus

GDPR_MSG — Fehlercodes (im Feld errors)

GDPR_VERIF — Fehlercodes (im Feld errors)

ID Mobile API

Wird von allen ID-Mobile-Scopes zurückgegeben: Simswap, Matching without OTP, Number Verify, Formfilling und Billing.

Fehler werden als JSON-Objekt mit drei Feldern zurückgegeben: status (error), error_id und error_type.

{
  "status": "error",
  "error_type": "invalid phone number",
  "error_id": "10"
}

Fehlercodes für Schritt 1 — alle Scopes

Diese Fehlercodes werden vom ersten API-Aufruf (Endpunkt /IDMOBILE/) für alle Scopes zurückgegeben.

Fehlercodes für Schritt 2 — Number Verify, Formfilling, Billing

Diese zusätzlichen Fehlercodes werden vom Abrufaufruf (Endpunkt /GET/) zurückgegeben, nachdem der Nutzer die Weiterleitung zum Betreiber abgeschlossen hat.