API Adresse — Vérifier et valider une adresse (Classic)

Support DQE
Support DQE
  • Mise à jour
Validation - API standard

Valide et normalise une adresse complète. Retourne une adresse corrigée, un verdict de délivrabilité (DQECodeDetail), et en option un détail des champs ayant été ajustés.

Quand appeler ce endpoint - RNVP est l'étape de validation de Niveau 2. Déclenchez-la lorsque l'utilisateur saisit une adresse librement ou modifie une suggestion DQE avant de la soumettre. Si l'utilisateur a accepté une suggestion DQE telle quelle, la qualité est déjà garantie - aucun appel n'est nécessaire.

Requête

Les méthodes GET et POST sont toutes deux prises en charge.

{SERVER_ADDRESS} et {LICENCE_CODE} sont fournis par DQE lors de la création du compte. Contactez votre chargé de compte DQE pour obtenir ces identifiants.
L'adresse saisie doit être encodée en URL - ex. l'églisel%27%C3%A9glise.
GEThttps://{SERVER_ADDRESS}/RNVP/?Adresse={INPUT}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Exemples cURL

France - avec Modification=O et Version=1.1

curl "https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Pays=FRA&Taille=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}"

International - Italie

curl "https://{SERVER_ADDRESS}/RNVP/?Adresse=%7CSTRADA%20BARDONEY%7C%7C11028%7CVALTOURNENCHE&Pays=ITA&Taille=38&Licence={LICENCE_CODE}"
POSThttps://{SERVER_ADDRESS}/RNVP/

Envoyez tous les paramètres dans le corps de la requête avec Content-Type: application/x-www-form-urlencoded. L'adresse du serveur reste dans l'URL.

Exemple cURL

France - adresse complète avec l'indicateur Modification

curl -X POST "https://{SERVER_ADDRESS}/RNVP/" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "Adresse=%7C1+rue+de+la+louisiane%7C%7C31200%7Ctoulouse" \ -d "Pays=FRA" \ -d "Taille=38" \ -d "Modification=O" \ -d "Version=1.1" \ -d "Licence={LICENCE_CODE}"

Paramètres

Paramètre Valeur Description Obl / Opt
Licence {LICENCE_CODE} Votre clé de licence DQE ou votre jeton OAuth2. Contactez le support si vous n'en avez pas encore. Obligatoire
Adresse {INPUT} Chaîne d'adresse séparée par des barres verticales (pipes). Les cinq barres sont obligatoires même lorsque les champs sont vides. Pour la France, un sixième segment peut être ajouté en tête pour le point de livraison (appartement, étage, boîte aux lettres).
adresse complémentaire|adresse|localité dépendante ou état|code postal|ville

Exemple : |1 rue de la louisiane||31200|toulouse

Obligatoire
Pays {COUNTRY_CODE} Code pays ISO 3166-1 alpha-3 pour le périmètre de recherche d'adresse. Exemple : FRA ou GBR. Obligatoire
Taille {LENGTH} Limite de caractères pour le champ de réponse Adresse. S'applique uniquement aux adresses en caractères latins. Valeur par défaut : 38. Minimum recommandé : 32. Optionnel
Instance {INSTANCE} Non renvoyé dans les résultats pour ce endpoint - peut être omis sans risque. Optionnel
Proposition {PROP} France uniquement. Contrôle la façon dont les résultats de correction sont retournés.
O - L'enregistrement "1" contient le résultat de correction standard. Si l'adresse ne peut pas être associée de façon unique, des suggestions supplémentaires sont retournées sous forme d'enregistrements "2" à "n".
S - L'enregistrement "1" retourne l'adresse saisie telle quelle avec son statut de validation (non corrigée). Si une correction claire est trouvée, elle est retournée sous forme d'enregistrement "2". Active automatiquement Modification=O.
Optionnel
Modification O Valeur fixe O. Ajoute Code_Modification et Status_Modification à la réponse, indiquant quels champs d'adresse ont été ajustés (adresse complémentaire, adresse, localité dépendante, code postal ou ville). Voir Code_Modification. Optionnel
Version {VERSION} 1.1 - Ajoute les champs de qualité de géocodage (LibelleQualiteGeo, CodeQualiteGeo) à la réponse (France uniquement, abonnement requis - contactez votre chargé de compte DQE pour l'activer).
2 - Retourne des données d'adresse complémentaires dans un champ ListeComplement.
Optionnel
Segmentation O France uniquement. Abonnement Finesis requis - contactez votre chargé de compte DQE pour l'activer. Définissez sur O pour ajouter Sprofil, Sportrait, Ssegment (champs de segmentation de population) à la réponse. Valeur par défaut : N. Optionnel

Champs de réponse

La réponse est un objet JSON avec une seule clé "1" dont la valeur est un dictionnaire de champs d'adresse. Lorsque Proposition=O, plusieurs enregistrements numérotés peuvent être retournés.

Champs de complément - La validation s'applique jusqu'au numéro de rue. Lorsqu'un complément est soumis (nom de bâtiment, étage, etc.) et correspond à un complément référencé, le moteur l'enrichit avec le nom complet enregistré. Lorsqu'aucun complément n'est soumis, la liste complète des compléments disponibles est retournée (séparés par des points-virgules). Les compléments non reconnus sont retournés tels quels.
Casse de sortie - La casse suit la norme postale du pays concerné.
Clé Description France International
DQECodeDetail Code de résultat de validation. Voir codes DQECodeDetail ci-dessous. String (2) String (2)
DQELibErreur Libellé texte du résultat de validation (OK ou une description d'erreur). String (38) String (38)
Adresse Ligne d'adresse normalisée (numéro de rue, type et nom de la voie). String (38) String (50)
Voie Nom de la voie sans numéro ni type. String (38) String (50)
TypeVoie Type de voie (ex. RUE, AVENUE, BOULEVARD). String (20) String (20)
Numero Numéro de rue complet, y compris tout complément (bis, ter, etc.). String (10) String (10)
NumSeul Numéro de rue seul, sans complément (bis, ter, etc.). String (10) String (10)
CompNum Complément du numéro de rue (bis, ter, etc.). String (38) String (50)
NbNumero
also: Nbnumero
Lorsque le numéro recherché n'est pas trouvé ou est absent, retourne le nombre total de numéros de rue valides pour cette voie. Peut être une chaîne vide pour certaines adresses internationales où cette donnée n'est pas disponible. String String
ListeNumero Liste des numéros valides pour cette voie, séparés par des points-virgules. Renseigné lorsque le numéro soumis est invalide ou absent. String (1024) String (1024)
CodePostal Code postal. String (5) String (10)
Localite Nom de la ville. String (38) String (50)
LieuDit Lieu-dit ou hameau nommé (France) ou champ équivalent de niveau district (international). Disponibilité variable selon le pays. String (38) String (50)
Cedex Indicateur CEDEX : 1 = adresse CEDEX, 0 = non CEDEX. String (1) String (1)
Ligne2 Informations complémentaires issues de la ligne d'adresse 2. String (38) String (38)
Complement Informations d'adresse complémentaires (nom de bâtiment, étage, etc.). String (1024) String (150)
ListeComplement Liste des compléments d'adresse disponibles (bâtiments, résidences, etc.) pour la voie trouvée, séparés par des points-virgules. Retourné lorsque Version=2. String (1024) String (1024)
IDLocalite Identifiant unique de la ville (code INSEE pour la France). String (20) String (20)
IDVoie
or CodeVoie
Identifiant unique de la voie. String (20) String (20)
Pays Code pays ISO 3166-1 alpha-3. String (3) String (3)
Province Code ISO de l'état ou de la région administrative. Toujours "*" String (50)
Region1 Libellé de l'état ou de la région. Non disponible String
Region2 Comté ou niveau administratif équivalent. Non disponible String
Region3 Comté ou équivalent (niveau alternatif). Non disponible String
Region4 Informations régionales ou administratives complémentaires. Non disponible String
Thoroughfare Voie dépendante. Non disponible Royaume-Uni uniquement
Entreprise Nom de l'entreprise associée à l'adresse. String (38) String (38)
Roudis Code de routage Roudis. France uniquement. String (5) Non disponible
IDHexaposte Identifiant postal de la ville (code Hexaposte pour la France). String (6) Non disponible
IDCle Identifiant unique du numéro de rue (Hexaclé pour la France). String (10) Non disponible
Latitude Coordonnées géographiques de l'adresse trouvée. Non disponible pour tous les pays - voir la couverture. String String
Longitude Coordonnées géographiques de l'adresse trouvée. Non disponible pour tous les pays - voir la couverture. String String
Status_IrisIlot Origine des codes IRIS et Ilot. Abonnement requis - contactez votre chargé de compte DQE pour l'activer. String (5) Non disponible
iris Code de l'unité statistique IRIS. France uniquement, abonnement requis - contactez votre chargé de compte DQE pour l'activer. String (9) Non disponible
ilot Code Ilot. Abonnement requis - contactez votre chargé de compte DQE pour l'activer. String Non disponible
Instance Champ interne. String (3) String (3)
LibelleQualiteGeo Libellé de qualité de géocodage (ex. ENTREE, BATIMENT). Renseigné lorsque Version=1.1. Voir Qualité de géocodage. String Non disponible
CodeQualiteGeo Code numérique de qualité de géocodage. Renseigné lorsque Version=1.1. String Non disponible
Sprofil Profil de population (Finesis). Retourné lorsque Segmentation=O. String (10) Non disponible
Sportrait Portrait de population (Finesis). Retourné lorsque Segmentation=O. String (10) Non disponible
Ssegment Segment de population (Finesis). Retourné lorsque Segmentation=O. String (10) Non disponible
Code_Modification Chaîne binaire de 5 caractères indiquant quels champs d'adresse ont été ajustés. Retourné lorsque Modification=O. Voir Code_Modification. String (5) String (5)
Status_Modification O si au moins un champ a été ajusté, N sinon. Retourné lorsque Modification=O. String (1) String (1)
DQECompte
DQECodeErreur
DQEPourcentErreur
Champs hérités conservés pour la compatibilité ascendante avec les anciennes intégrations. À ne pas utiliser dans les nouvelles implémentations. String Non disponible

Retourné avec Version=1.1 Retourné avec Segmentation=O Retourné avec Modification=O

Exemples de réponse

|1 Rue de la Louisiane||31200|Toulouse
{ "1": { "Roudis": "4221", "DQECompte": "", "Instance": "", "CodePostal": "31200", "Status_IrisIlot": "INSEE", "Latitude": "43.634746", "Localite": "TOULOUSE", "Province": "*", "NbNumero": "0", "Complement": "BATIMENT D RESIDENCE ALLEE DES CEDRES;BATIMENT A RESIDENCE ALLEE DES CEDRES;BATIMENT B RESIDENCE ALLEE DES CEDRES;BATIMENT C RESIDENCE ALLEE DES CEDRES", "Voie": "DE LA LOUISIANE", "Adresse": "1 RUE DE LA LOUISIANE", "Cedex": "", "Numero": "1", "ListeNumero": "", "IDHexaposte": "14411", "IDCle": "3155526YEA", "Nbnumero": "0", "LieuDit": "", "ilot": "", "TypeVoie": "RUE", "DQECodeDetail": "10", "DQELibErreur": "OK", "Longitude": "1.430098", "CompNum": "", "iris": "3701", "IDLocalite": "31555", "DQECodeErreur": "0", "Pays": "FRA", "IDVoie": "2408474", "NumSeul": "1", "Ligne2": "", "DQEPourcentErreur": "0" } }

Codes DQECodeDetail

DQECodeDetail est l'indicateur principal du résultat de validation. Utilisez-le pour déterminer quelle action entreprendre lors de la soumission du formulaire.
Pour les messages d'interface recommandés associés à chaque code, consultez le Guide d'intégration.

Code Description
10 Adresse correcte
20 Adresse correcte (voie non reconnue, mais il s'agit d'un CEDEX ou d'une boîte postale)
21 Petite ville, numéro de rue hors plage
22 Petite ville, numéro de rue manquant (le reste de l'adresse est correct)
23 Grande ville, numéro de rue hors plage
24 Grande ville, numéro de rue manquant (le reste de l'adresse est correct)
25 Adresse CEDEX inconnue de CEDEXA (si CEDEXA est actif)
30 Petite ville, voie non reconnue
31 Petite ville - voie non reconnue ou manquante ; informations de quartier reconnues mais insuffisantes pour déterminer la voie. France uniquement.
40 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
41 Petite ville, voie manquante
50 Grande ville, voie non reconnue
51 Grande ville, voie non reconnue ou manquante (informations de quartier reconnues mais insuffisantes pour déterminer la voie). France uniquement.
60 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
61 Grande ville, voie manquante
70 Incohérence code postal / ville - voie présente
71 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
80 Incohérence code postal / ville - voie manquante
81 Bloc d'adresse saisi vide. Non retourné pour la France.
90 Adresse internationale détectée - le code pays saisi ne semble pas correspondre à l'adresse saisie.
95 Code pays manquant ou incorrect
Petite vs grande ville - En France, une ville est considérée comme Grande lorsqu'elle compte plus de 2 500 habitants. À l'international, le seuil est de 500 voies. Cette distinction détermine si les codes de petite ville (21, 22, 30, 31, 41) ou les codes de grande ville (23, 24, 50, 51, 61) s'appliquent.
Quartier - Les codes 31 et 51 indiquent qu'un quartier a été reconnu : une zone géographique identifiée par le moteur (ex. un hameau ou un lotissement) qui ne peut pas être associée à une voie précise. Ces codes sont réservés à la France.
Postal address validation process

DQECodeDetail - exemples de saisie

Exemples de saisies produisant chaque code. Les champs non listés sont laissés vides.

Code France International
10 |20 rue Jean-Baptiste Pigalle||75009|Paris Albert Buildings|3 Scott Drive||WA15 8AB|ALTRINCHAM
GBR
20 |RUE DES FRERES LUMIERE|BP 30036|33564|CARBON BLANC -
21 |26 route du chardonnay||24130|Ginestet |Seulestraat 200||8950|Heuvelland
BEL
22 |route du chardonnay||24130|Ginestet |Seulestraat||8950|Heuvelland
BEL
23 |13 rue Jean-Baptiste Pigalle||75009|Paris |Rue Victor Hugo 235||7012|Mons
BEL
24 |rue Jean-Baptiste Pigalle||75009|Paris |Rue Victor Hugo||7012|Mons
BEL
25 |||82016|Montauban CEDEX -
30 |rue Jean-Baptiste Pigalle||24130|Ginestet |Via del lungo||70011|Alberobello
ITA
31 |SAINT SYMPHORIEN||12490|VIALA DU TARN Non retourné hors de France
40 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité. Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
41 |||24130|Ginestet |||70011|Alberobello
ITA
50 |route du chardonnay||75009|Paris |STREET ABCD||60607|CHICAGO
USA
51 |Lotissement Casella||20243|PRUNELLI DI FIUMORBO Non retourné hors de France
60 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité. Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
61 |||75009|Paris |||60607|CHICAGO
USA
70 |rue de la mairie||75009|Bordeaux |FRANKLIN GTWY SE||00067|MARIETTA
USA
71 Non attendu dans les déploiements cloud actuels. Défini pour compatibilité. Non attendu dans les déploiements cloud actuels. Défini pour compatibilité.
80 |||75009|Bordeaux |||00067|MARIETTA
USA
81 Non retourné pour la France ||||
90 |7C avenue Monbijou||4960|Malmedy
Pays : FRA - l'adresse semble non française
-
95 - -

Code_Modification

Retourné lorsque Modification=O est ajouté à la requête. Status_Modification vaut O si un champ a été ajusté, N sinon. Code_Modification est une chaîne binaire de 5 caractères, une position par champ d'adresse. 1 = ajusté par DQE, 0 = inchangé.

adresse complémentaire|adresse|localité dépendante|code postal|ville
Code_Modification Signification
00000 Aucun champ ajusté - adresse acceptée telle que soumise.
11111 Les cinq champs ont été ajustés.
00011 Code postal et ville ajustés ; les autres champs sont inchangés.
01111 Adresse, localité dépendante, code postal et ville ajustés ; adresse complémentaire inchangée.
10000 Seule l'adresse complémentaire a été ajustée.
01000 Seule la ligne d'adresse a été ajustée.
00100 Seule la localité dépendante a été ajustée.
Astuce - Lorsque Status_Modification vaut O, au moins un champ a été modifié par DQE. Affichez la correction à l'utilisateur sous forme de popup, en conservant toujours la possibilité de garder sa saisie d'origine.

Qualité de géocodage

Lorsque Version=1.1 est défini et que le géocodage est souscrit, deux champs sont ajoutés : LibelleQualiteGeo (libellé) et CodeQualiteGeo (code numérique). France uniquement.

Code LibelleQualiteGeo Description
1 ENTREE Point d'accès principal à une enceinte, un groupe de bâtiments ou une parcelle (plaque d'adresse).
2 BATIMENT Bâtiment ou partie de bâtiment.
3 ESCALIERS Cage d'escalier, généralement à l'intérieur d'un bâtiment.
4 LOGEMENT Logement ou pièce à l'intérieur d'un bâtiment.
5 PARCELLE CADASTRALE Parcelle cadastrale.
6 SEGMENT DE VOIE Position dérivée du segment de voie de raccordement. Peut se situer hors du polygone de la ville mais sur la même voie.
7 POINT D ACCESS TECHNIQUE Point d'accès technique (eau, électricité, coupure gaz, etc.).
8 POINT DELIVRANCE POSTALE Point de livraison postale (boîte aux lettres).
9 ZONE D ADRESSAGE Point placé dans la localité dépendante.
10 CENTRE VILLE Centre de la ville.
0 CENTRE DE LA VOIE Point au centre de la voie.
90 A CONTROLER Qualité de géocodage incertaine - à vérifier.
99 NON PRESENTE Géocodage non disponible pour cette adresse.

Erreurs

Contrairement aux API de suggestion, RNVP retourne des codes d'erreur HTTP standards (et non un corps vide) lorsque des paramètres requis sont manquants ou invalides.

HTTP Type d'erreur Corps de la réponse
400 Licence Licence manquante ou vide Bad Request Parameters empty fields
401 Licence incorrecte unauthorized_client
400 Adresse manquante ou vide Bad Request Parameters empty fields
400 Pays manquant ou vide Bad Request Parameters empty fields
400 Valeur de paramètre invalide Bad Request Parameters empty fields

Tester l'API

Cliquez sur le bouton ci-dessous pour tester ce endpoint en direct dans votre navigateur.

Ouvrir la console

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0