Codes de réponse API — Référence complète

Cette page est une référence complète pour tous les codes de réponse retournés par les API DQE — à la fois les erreurs de niveau HTTP et les codes de validation spécifiques à chaque service. Utilisez les sections ci-dessous pour rechercher n'importe quel code que vous recevez.

• Erreurs HTTP — communes à toutes les API
• Email API
• Phone API
• Address API — CheckAddress (DQECodeDetail)
• Geocoding API (CodeQualiteGeo)
• B2B API
• SMS Phone Confirmation API
• ID Mobile API

Erreurs HTTP — communes à toutes les API

Ces erreurs se produisent au niveau du transport HTTP et sont communes à tous les services API DQE.

API Classic

API Restful

Les API Restful retournent des objets d'erreur JSON structurés selon le format suivant :

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

Email API

Retourné par API Email — Valider une adresse e-mail (Classic) et Restful Email API — email/lookup.

Codes IdError

Le champ IdError est le résultat de validation principal pour chaque requête d'e-mail.

Codes CodeActivite (vérification niveau 2)

Retourné uniquement lorsque la vérification niveau 2 est activée. M = mois en cours.

Phone API

Retourné par Phone API — Classic et Restful Phone API — phonelookup.

Codes IdError

Codes de statut (vérification niveau 2 — API Classic)

Retourné lorsque Status=Y est défini dans la requête. Numéros de mobile français uniquement.

Address API — CheckAddress (DQECodeDetail)

Retourné par API Adresse — Vérifier et valider une adresse (Classic) et API Adresse — Vérifier et valider une adresse (RESTful). Le champ DQECodeDetail (Classic) / DQEDetailCode (RESTful) donne le score de qualité de validation de l'adresse. Les messages d'interface suggérés proviennent de API Adresse — Guide d'intégration.

Guide d'interprétation rapide : Codes 10, 20, 25 = l'adresse est valide. Code 90 = adresse internationale, incohérence de code pays — veuillez vérifier. Codes 21–24 = problème de numéro. Codes 30–61 = problème de rue (hors codes obsolètes 40/60). Code 70 = incohérence code postal/ville, rue présente. Code 80 = incohérence code postal/ville, rue manquante. Code 81 = saisie vide. Code 95 = pays incorrect. Les codes 40, 60, 71 sont obsolètes — conservés uniquement pour la compatibilité.

Geocoding API (CodeQualiteGeo)

Retourné par API Géocodage — Obtenir les coordonnées GPS et par CheckAddress lorsque Version=1.1. Le champ CodeQualiteGeo indique le niveau de précision des coordonnées géographiques.

Remarque : Lorsque le paramètre Licence est manquant ou invalide, l'API Geocoding retourne Latitude: "0.00" et Longitude: "0.00" au lieu d'une erreur HTTP.

B2B API

Retourné par B2B Classic API — RECSIRET, B2B Classic API — SIRETINFO, Restful B2B API — Lookup, et Restful B2B API — GetInfo.

DQE_status (API Classic — formulaire étendu SIRETINFO)

CompanyStatus

MainCompanyFlag

SMS Phone Confirmation API

Retourné par API SMS Phone Confirmation — Envoyer un code OTP (GDPR_MSG) et API SMS Phone Confirmation — Vérifier un code OTP (GDPR_VERIF).

GDPR_MSG — statut de livraison SMS

GDPR_MSG — codes d'erreur (dans le champ errors)

GDPR_VERIF — codes d'erreur (dans le champ errors)

ID Mobile API

Retourné par tous les scopes ID Mobile : Simswap, Matching without OTP, Number Verify, Formfilling, et Billing.

Les erreurs sont retournées sous la forme d'un objet JSON contenant trois champs : status (error), error_id, et error_type.

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

Codes d'erreur de l'étape 1 — tous les scopes

Ces codes d'erreur sont retournés par le premier appel API (endpoint /IDMOBILE/) pour tous les scopes.

Codes d'erreur de l'étape 2 — Number Verify, Formfilling, Billing

Ces codes d'erreur supplémentaires sont retournés par l'appel de récupération (endpoint /GET/) une fois que l'utilisateur a terminé la redirection opérateur.