API - Description - Address - CheckAddress - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the /RNVP/ endpoint used to validate and correct a completed postal address.

Related Address documentation:

CheckAddress response success

The JSON response is a dictionary containing a single element "1" and whose value is a dictionary containing, among others, all the fields of the address possibly corrected:

Request example:

  • https://{SERVER_ADDRESS}/RNVP/?Pays=FRA&Adresse=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Taille=38&Proposition=O&Modification=O&Version=1.1&Licence={LICENCE_CODE}
Key Value France International
Roudis Roudis Code (France only) STRING(5) Not available
CodePostal City Zip Code STRING(5) STRING(10)
Localite City name STRING(38) STRING(50)
Province Region where the city is located. Type will depend on the country where the search is performed. For the USA, the state's 2-letter code is returned here. Not available STRING(50)
IDLocalite Unique code for each city (INSEE code for France) STRING(20) STRING(20)
Pays ISO country code STRING(3) STRING(3)
Numero Number in the street with the number complement (bis, ter, etc.) STRING(4) STRING(4)
NumSeul Number in the street STRING(4) STRING(4)
ListeNumero List of available numbers in the street. This key is available when the number entered is invalid or when no number has been entered. STRING(1024) STRING(1024)
NbNumero or Nbnumero Number of numbers in the street STRING(4) STRING(4)
CompNum Number complement (bis, ter, etc.) STRING(38) STRING(50)
TypeVoie Street type (street, avenue, etc.) STRING(20) STRING(20)
Voie Street name, without number or type STRING(38) STRING(50)
Adresse Street including street number and type STRING(38) STRING(50)
Cedex Cedex from the address entered STRING(5) STRING(10)
Ligne2 Contains additional information from line 2 of the address STRING(38) STRING(38)
LieuDit Dependent locality if applicable STRING(38) STRING(50)
IDVoie or CodeVoie Unique number to designate the street STRING(20) STRING(20)
Complement Additional address information STRING(1024) STRING(150)
Instance Number passed as a parameter during the call and returned in the response STRING(1) STRING(1)
Latitude Latitude code of the centre of the locality DECIMAL(18) DECIMAL(18)
Longitude Longitude code of the centre of the locality DECIMAL(18) DECIMAL(18)
Status_IrisIlot Origin of IRIS and Ilot codes STRING(5) Not available
iris IRIS code STRING(9) Not available
ilot Ilot code
IDHexaposte Hexaposte ID STRING(6) Not available
IDCle Hexaclé ID STRING(10) Not available
DQECodeDetail Return code detailed below STRING(2) STRING(2)
DQELibErreur OK or KO STRING(38) STRING(38)
DQECompte Old response - kept for compatibility reasons on old integrations STRING Not available
DQECodeErreur Old response - kept for compatibility reasons on old integrations STRING Not available
DQEPourcentErreur Old response - kept for compatibility reasons on old integrations STRING Not available
Region1 Region Not available STRING
Region2 County Not available STRING
Region3 County Not available STRING
Region4 County Not available STRING
Thoroughfare Dependant street Not available UK Only
Entreprise Company name STRING(38) UK Only
Sprofil If Segmentation=O, profile of the address STRING(10) Not available
Sportrait If Segmentation=O, portrait of the address STRING(10) Not available
Ssegment If Segmentation=O, segment of the address STRING(10) Not available

Example:

{
  "1": {
    "Adresse": "STRADA BARDONEY",
    "DQECompte": "",
    "Instance": "",
    "CodePostal": "11028",
    "Status_IrisIlot": "",
    "Latitude": "",
    "Localite": "VALTOURNENCHE",
    "Province": "AO",
    "NbNumero": "",
    "Complement": "",
    "Voie": "BARDONEY",
    "Roudis": "",
    "ListeNumero": "",
    "Numero": "",
    "Cedex": "",
    "IDHexaposte": "",
    "IDCle": "",
    "LieuDit": "",
    "ilot": "",
    "TypeVoie": "STRADA",
    "Longitude": "",
    "CompNum": "",
    "iris": "",
    "IDLocalite": "16237",
    "DQECodeErreur": "",
    "IDVoie": "",
    "NumSeul": "",
    "DQEPourcentErreur": "",
    "Region1": "VALLE D'AOSTA",
    "Region2": "VALLE D AOSTA",
    "Region3": "",
    "Region4": "",
    "Ligne2": "",
    "Pays": "ITA",
    "DQELibErreur": "Small city, street name not found",
    "DQECodeDetail": "30"
  }
}

Schema of DQECodeDetail:

DQECodeDetail decision flow diagram

DQECodeDetail table:

Code Description Internal Description UI Display
10 Correct address Valid address Valid address
20 Correct address (street not recognized, but it is a CEDEX or P.O. box) Valid address Valid address
21 Small town, street number out of range Please confirm the address with the client (street number does not exist) Please check your postal address
22 Small town, street number missing (the rest of the address is correct) Please confirm the address with the client (street number missing) Please check your postal address
23 Large city, street number out of range Please confirm the address with the client (street number does not exist) Please check your postal address
24 Large city, street number missing (the rest of the address is correct) Please confirm the address with the client (street number missing) Please check your postal address
25 CEDEX address unknown to CEDEXA (if CEDEXA is active) Valid address Valid address
30 Small town, street not recognized Please confirm the address with the client (street name not found) Please check your postal address
31 Small town, street not recognized Please confirm the address with the client (street name not found) Please check your postal address
40 Small town, street missing (district information recognized, but not enough to deduce the street) Please confirm the address with the client (street name not found) Please check your postal address
41 Small town, street missing Please confirm the address with the client (street name missing) Please check your postal address
50 Large city, street not recognized Please confirm the address with the client (street name not found) Please check your postal address
51 (France only) Large city, street not recognized (district information recognized, but not enough to deduce the street) Please confirm the address with the client (street name not found) Please check your postal address
60 Large city, street missing (district information recognized, but not enough to deduce the street) Please confirm the address with the client (street name not found) Please check your postal address
61 Large city, street missing Please confirm the address with the client (street name missing) Please check your postal address
70 Postal code/City not correctable (street present) Address is incorrect. The postal code/city do not match. Please check your postal address
71 Postal code/City not correctable (street missing) Address is incorrect. The postal code/city do not match. Please check your postal address
80 Input “address” block empty Address not filled in Please check your postal address
81 Input “address” block empty Address not filled in Please check your postal address
90 International address detected Valid address Valid address
95 Missing or incorrect country code Missing or incorrect country code Please check your postal address

Examples:

  • Code 10:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C102%20rue%20victor%20hugo%7C%7C92300%7Clevallois%20perret&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 20:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C%7CChessy%7C77777%7CMARNE%20LA%20VALLEE%20CEDEX%204&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 21:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C5%20Rue%20des%20amandiers%7C%7C17940%7CRivedouxplage&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 22:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%20%7CRue%20des%20amandiers%7C%7C17940%7CRivedoux%20plage&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 23:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C35%20Rue%20daubigny%7C%7C75017%7CParis&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 24:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7CRue%20daubigny%7C%7C75017%7CParis&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 30:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7CRuedaubigny%7C%7C17940%7CRivedoux%20plage&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 41:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C%7C%7C17940%7CRivedoux%20plage&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 50:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7Crue%20du%20four%7C%7C17000%7CLa%20rochelle&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 61:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C%7C%7C75017%7CParis&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 70:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7Crue%20daubigny%7C%7C17000%7CParis&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 80:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C%7C%7C17000%7CParis&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 90:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C20%20Avenue%20Monbijou%20%7C%20%7C%204960%7CMALMEDY&Instance=0&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
  • Code 95:
    https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C102%20rue%20victor%20hugo%7C%7C92300%7Clevallois%20perret&Instance=0&Taille=38&Pays=FR&Licence={LICENCE_CODE}

CodeModification table:

Request:

https://{SERVER_ADDRESS}/RNVP/?Adresse=RESIDENCE%20LE%20LAC|2%20RUE%20RONSARD|MEUDON%20LA%20FORET|92360|MUDON&Instance=0&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Response: "Code_Modification": "11111"

Additional address Address Dependent locality or state Zip code City
1 1 1 1 1
Adjusted Adjusted Adjusted Adjusted Adjusted

Request:

https://{SERVER_ADDRESS}/RNVP/?Adresse=RESIDENCE%20LE%20LAC|2%20RUE%20RONSART|MEUDEN%20LA%20FORET|92460|MUDON&Instance=0&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Response: "Code_Modification": "01111"

Additional address Address Dependent locality or state Zip code City
0 1 1 1 1
OK Adjusted Adjusted Adjusted Adjusted

Request:

https://{SERVER_ADDRESS}/RNVP/?Adresse=RESIDENCE%20LE%20LAC|2%20RUE%20RONSARD|MEUDEN%20LA%20FORET|92460|MUDON&Instance=0&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Response: "Code_Modification": "00111"

Additional address Address Dependent locality or state Zip code City
0 0 1 1 1
OK OK Adjusted Adjusted Adjusted

Request:

https://{SERVER_ADDRESS}/RNVP/?Adresse=RESIDENCE%20LE%20LAC|2%20RUE%20RONSARD|MEUDON%20LA%20FORET|92460|MUDON&Instance=0&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Response: "Code_Modification": "00011"

Additional address Address Dependent locality or state Zip code City
0 0 0 1 1
OK OK OK Adjusted Adjusted

Request:

https://{SERVER_ADDRESS}/RNVP/?Adresse=RESIDENCE%20LE%20LAC|2%20RUE%20RONSARD|MEUDON%20LA%20FORET|92360|MUDON&Instance=0&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

Response: "Code_Modification": "00001"

Additional address Address Dependent locality or state Zip code City
0 0 0 0 1
OK OK OK OK Adjusted

LibelleQualiteGeo and CodeQualiteGeo table:

CodeQualiteGeo LibelleQualiteGeo Description
1 ENTREE Main access point to an open or closed enclosure, a group of buildings, or a piece of land.
2 BATIMENT Building or part of a building.
3 ESCALIERS Stairwell, normally inside a building.
4 LOGEMENT Housing or room inside a building.
5 PARCELLE CADASTRALE Cadastral parcel.
6 SEGMENT DE VOIE Position derived from the connecting street segment.
7 POINT D ACCESS TECHNIQUE Technical access point.
8 POINT DELIVRANCE POSTALE Postal delivery point, such as a mailbox.
9 ZONE D ADRESSAGE Point placed in the dependent locality.
10 CENTRE VILLE City center.
00 CENTRE DE LA VOIE Point in the center of the street.
90 A CONTROLER To check.
99 NON PRESENTE Not available.

CheckAddress response error

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/RNVP/?Pays=FRA&Adresse=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Taille=38 Empty response
Empty Licence parameter https://{SERVER_ADDRESS}/RNVP/?Pays=FRA&Adresse=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Taille=38&Licence= Empty response
Incorrect licence number https://{SERVER_ADDRESS}/RNVP/?Pays=FRA&Adresse=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Taille=38&Licence={INCORRECT_LICENCE_CODE} Empty response
Missing Adresse parameter https://{SERVER_ADDRESS}/RNVP/?Pays=FRA&Taille=38&Licence={LICENCE_CODE} 400 Bad Request Error
Missing Pays parameter https://{SERVER_ADDRESS}/RNVP/?Adresse=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Taille=38&Licence={LICENCE_CODE} 400 Bad Request Error
Error on a parameter https://{SERVER_ADDRESS}/RNVP/?Adrese=%7C5%20rue%20des%20Pyrenees%7C%7C75020%7CPARIS&Pays=FRA&Taille=38&Licence={LICENCE_CODE} 400 Bad Request Error

Related to

Was this article helpful?

0 out of 0 found this helpful