API Restful - Description - Address - Check Address - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the Restful /checkaddress/ endpoint.

Related Address documentation:

Checkaddress response success

The JSON response is a dictionary containing two main keys:

  • Found: number of addresses found.
  • Addresses: list containing one or more address objects.

Each address object contains the following fields:

Key Description Value Type
Found Number of addresses found. 3 Integer
Addresses List of addresses returned by the service. [ { "Address": "8 VICTOR HUGO", "PostalCode": "92300", ... } ] Array of objects
Addresses[0].Address Complete address line. "8 VICTOR HUGO" String
Addresses[0].PostalCode Postal code of the address. "92300" String
Addresses[0].City City name. "LEVALLOIS PERRET" String
Addresses[0].Country Country code, ISO 3 letters. "FRA" String
Addresses[0].Street Street name. "VICTOR HUGO" String
Addresses[0].StreetType Type of street, for example RUE or SQUARE. "" String
Addresses[0].StreetNumberOnly Street number only. "8" String
Addresses[0].Latitude Latitude coordinate. "48.8927685421544" String
Addresses[0].Longitude Longitude coordinate. "2.28767174943166" String
Addresses[0].Informations Additional DQE information related to the address. { "DQEDetailCode": "50", "DQEErrorAddressLabel": "KO", ... } Object
Addresses[0].Informations.DQEDetailCode DQE detail code describing the validation result. "50" String
Addresses[0].Informations.DQEErrorAddressLabel Label indicating whether the address is valid (OK) or invalid (KO). "KO" String
Addresses[0].Informations.PostalCityId Internal postal/city reference identifier. "37847" String
Addresses[0].Informations.IsAddressChanged Indicates whether the address was modified during normalization. "1" String

Example:

{
  "Found": 3,
  "Addresses": [
    {
      "Address": "8 VICTOR HUGO",
      "PostalCode": "92300",
      "City": "LEVALLOIS PERRET",
      "Hamlet": "",
      "SpecialDistribution": "",
      "Country": "FRA",
      "StateCode": "*",
      "SubLocality": "",
      "CityId": "92044",
      "Input": "",
      "Label": "",
      "AdditionalAddress": "",
      "StreetNumber": "",
      "StreetType": "",
      "Street": "VICTOR HUGO",
      "StreetId": "",
      "IsValidStreetNumber": "",
      "StreetNumberListCount": "",
      "StreetNumberList": "",
      "StreetNumberOnly": "8",
      "StateLabel": "",
      "AdministrativeArea": "",
      "Suburb": "",
      "Company": "",
      "Latitude": "48.8927685421544",
      "Longitude": "2.28767174943166",
      "Informations": {
        "AdditionalAddressComp": "",
        "StreetNumberComp": "",
        "DQEDetailCode": "50",
        "DQEErrorAddressLabel": "KO",
        "StreetNumberId": "",
        "PostalCityId": "37847",
        "IrisCode": "",
        "RoudisCode": "",
        "LatLonLabel": "",
        "LatLonCode": "",
        "IsAddressChanged": "1",
        "ChangedAddressTag": ""
      }
    },
    {
      "Address": "8 SQUARE VICTOR HUGO",
      "PostalCode": "92300",
      "City": "LEVALLOIS PERRET",
      "Hamlet": "",
      "SpecialDistribution": "",
      "Country": "FRA",
      "StateCode": "*",
      "SubLocality": "",
      "CityId": "92044",
      "Input": "",
      "Label": "",
      "AdditionalAddress": "",
      "StreetNumber": "",
      "StreetType": "SQUARE",
      "Street": "VICTOR HUGO",
      "StreetId": "1749909",
      "IsValidStreetNumber": "",
      "StreetNumberListCount": "",
      "StreetNumberList": "8",
      "StreetNumberOnly": "8",
      "StateLabel": "",
      "AdministrativeArea": "",
      "Suburb": "",
      "Company": "",
      "Latitude": "48.894735",
      "Longitude": "2.298562",
      "Informations": {
        "AdditionalAddressComp": "",
        "StreetNumberComp": "",
        "DQEDetailCode": "10",
        "DQEErrorAddressLabel": "OK",
        "StreetNumberId": "92044227P2",
        "PostalCityId": "37847",
        "IrisCode": "0122",
        "RoudisCode": "",
        "LatLonLabel": "",
        "LatLonCode": "",
        "IsAddressChanged": "1",
        "ChangedAddressTag": ""
      }
    },
    {
      "Address": "8 RUE VICTOR HUGO",
      "PostalCode": "92300",
      "City": "LEVALLOIS PERRET",
      "Hamlet": "",
      "SpecialDistribution": "",
      "Country": "FRA",
      "StateCode": "*",
      "SubLocality": "",
      "CityId": "92044",
      "Input": "",
      "Label": "",
      "AdditionalAddress": "",
      "StreetNumber": "",
      "StreetType": "RUE",
      "Street": "VICTOR HUGO",
      "StreetId": "1749869",
      "IsValidStreetNumber": "",
      "StreetNumberListCount": "",
      "StreetNumberList": "8",
      "StreetNumberOnly": "8",
      "StateLabel": "",
      "AdministrativeArea": "",
      "Suburb": "",
      "Company": "",
      "Latitude": "48.893157",
      "Longitude": "2.300094",
      "Informations": {
        "AdditionalAddressComp": "",
        "StreetNumberComp": "",
        "DQEDetailCode": "10",
        "DQEErrorAddressLabel": "OK",
        "StreetNumberId": "920442292P",
        "PostalCityId": "37847",
        "IrisCode": "0122",
        "RoudisCode": "",
        "LatLonLabel": "",
        "LatLonCode": "",
        "IsAddressChanged": "1",
        "ChangedAddressTag": ""
      }
    }
  ]
}

Schema of DQEDetailCode:

DQEDetailCode decision flow diagram

DQEDetailCode 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

LatLonLabel and LatLonCode table (if Version=1.1 in the request):

LatLonLabel LatLonCode Description
1 ENTREE Main access point to an open or closed enclosure, to a group of buildings or to a piece of land (address plate).
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 segment of the connecting street. Modification of some BAN data because located outside the city polygon, but on the same street.
7 POINT D ACCESS TECHNIQUE Technical access point, for example room with water, electricity, gas shut offs, etc.
8 POINT DELIVRANCE POSTALE Postal delivery point (mailbox).
9 ZONE D ADRESSAGE Point placed in the dependent locality.
10 CENTRE VILLE Center of the city.
0 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
400 Missing a mandatory parameter 
{
  "status": 400,
  "message": "Missing parameters",
  "details": "Number",
  "error": "bad request"
}
401 Unauthorized client 
{
  "status": 401,
  "message": "Your licence is not allowed to cover this functionality",
  "details": "deded",
  "error": "unauthorized_client"
}

Related to

Was this article helpful?

0 out of 0 found this helpful