API Restful - Description - Address - Check Address - Response

Support DQE
Support DQE
  • Updated

Checkaddress response success

The JSON response is a dictionary (object) containing two main keys:

  • "Found": an integer indicating the number of addresses found (e.g., 0 or 1),
  • "Addresses": a list containing one or more address objects.

Each address object is itself a dictionary containing the following keys:

KeyDescriptionValueType
FoundNumber of addresses found.3Integer
AddressesList of addresses returned by the service.[ { "Address": "8 VICTOR HUGO", "PostalCode": "92300", ... } ]Array of objects
Addresses[0].AddressComplete address line."8 VICTOR HUGO"String
Addresses[0].PostalCodePostal code of the address."92300"String
Addresses[0].CityCity name."LEVALLOIS PERRET"String
Addresses[0].CountryCountry code (ISO 3 letters)."FRA"String
Addresses[0].StreetStreet name."VICTOR HUGO"String
Addresses[0].StreetTypeType of street (e.g., “RUE”, “SQUARE”).""String
Addresses[0].StreetNumberOnlyStreet number only."8"String
Addresses[0].LatitudeGeographic coordinate (latitude)."48.8927685421544"String
Addresses[0].LongitudeGeographic coordinate (longitude)."2.28767174943166"String
Addresses[0].InformationsAdditional DQE information related to the address.{ "DQEDetailCode": "50", "DQEErrorAddressLabel": "KO", ... }Object
Addresses[0].Informations.DQEDetailCodeDQE detail code describing the validation result."50"String
Addresses[0].Informations.DQEErrorAddressLabelLabel indicating if the address is valid (“OK”) or invalid (“KO”)."KO"String
Addresses[0].Informations.PostalCityIdInternal postal/city reference identifier."37847"String
Addresses[0].Informations.IsAddressChangedIndicates if 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 :

SchemaDQECodeDetailFlow

DQEDetailCode table :

CodeDescriptionInternal DescriptionUI Display
10Correct addressValid addressValid address
20Correct address (street not recognized, but it is a CEDEX or P.O. box)Valid addressValid address
21Small town, street number out of rangePlease confirm the address with the client (street number does not exist)Please check your postal address
22Small 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
23Large city, street number out of rangePlease confirm the address with the client (street number does not exist)Please check your postal address
24Large 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
25CEDEX address unknown to CEDEXA (if CEDEXA is active)Valid addressValid address
30Small town, street not recognizedPlease confirm the address with the client (street name not found)Please check your postal address
31Small town, street not recognizedPlease confirm the address with the client (street name not found)Please check your postal address
40Small town, street missing (district information recognized, but not enough to deduce the streetPlease confirm the address with the client (street name not found)Please check your postal address
41Small town, street missingPlease confirm the address with the client (street name missing)Please check your postal address
50Large city, street not recognizedPlease confirm the address with the client (street name not found)Please check your postal address
51Large 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
60Large 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
61Large city, street missingPlease confirm the address with the client (street name missing)Please check your postal address
70Postal code/City not correctable (street present)Address is incorrect. The postal code/city do not match.Please check your postal address
71Postal code/City not correctable (street missing)Address is incorrect. The postal code/city do not match.Please check your postal address
80Input “address” block emptyAddress not filled inPlease check your postal address
81Input “address” block emptyAddress not filled inPlease check your postal address
90International address detectedValid addressValid address
95Missing or incorrect country codeMissing or incorrect country codePlease check your postal address

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

LatLonLabelLatLonCodeDescription
1ENTREEMain access point to an open or closed enclosure, to a group of buildings or to a piece of land (address plate)
2BATIMENTBuilding or part of a building
3ESCALIERSStairwell, normally inside a building
4LOGEMENTHousing or room inside a building.
5PARCELLE CADASTRALECadastral parcel
6SEGMENT DE VOIEPosition derived from the segment of the connecting street. (Modification of some BAN data because located outside the city polygon, but on the same street)
7POINT D ACCESS TECHNIQUETechnical access point (e.g., room with water, electricity, gas shut offs, etc.)
8POINT DELIVRANCE POSTALEPostal delivery point (mailbox)
9ZONE D ADRESSAGEPoint placed in the dependent locality
10CENTRE VILLECenter of the city
0CENTRE DE LA VOIEPoint in the center of the street
90A CONTROLERTo check
99NON PRESENTENot available

Checkaddress response error

Error typeRequestResponse type
400Missing a mandatory parameter{
 "status": 400,
 "message": "Missing parameters",
 "details": "Number",
 "error": "bad request"
}
401Unauthorized client{
 "status": 401,
 "message": "Your licence is not allowed to cover this functionnality",
 "details": "deded",
 "error": "unauthorized_client"
}

Related to

Was this article helpful?

0 out of 0 found this helpful