This page describes the JSON response returned by the /SINGLEV2/ endpoint.
Related Address documentation:
SINGLEV2 success response
The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains one address suggestion.
Example requests
https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=place%20de%20l%27eglise%20saint%20gervais%20rouen&Taille=38&Pays=FRA&Licence={LICENCE_CODE}https://{SERVER_ADDRESS}/SINGLEV2/?Pays=GBR&Adresse=B1%201SB&Taille=38&NbMax=30&Version=1&Licence={LICENCE_CODE}https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=Rue%20de%20Pietrain%20124&Taille=38&Pays=BEL&Licence={LICENCE_CODE}https://{SERVER_ADDRESS}/SINGLEV2/?Pays=USA&Adresse=110%20AVENUE&Taille=38&NbMax=30&Version=1&Licence={LICENCE_CODE}
| Key | Value | France | International |
|---|---|---|---|
| Instance | Value passed as a parameter during the call and returned in the response. | STRING(3) | STRING(3) |
| Province | Region where the city is located. For the USA, this field contains the 2-letter state code. | Not available | STRING(50) |
| IDLocalite | Unique code for each city. INSEE code for France. | STRING(20) | STRING(20) |
| CodePostal | City postal code. | STRING(10) | STRING(10) |
| Localite | City name. | STRING(38) | STRING(50) |
| SousLocalite | Used for countries other than France. | Empty | STRING(50) |
| Pays | ISO country code. | STRING(3) | STRING(3) |
| LieuDit | Dependent locality if applicable. | STRING(38) | Empty |
| Latitude | Latitude of the address. | Not available | Empty |
| Longitude | Longitude of the address. | Not available | Empty |
| IDVoie or CodeVoie | Unique number identifying the street. | STRING(20) | STRING(20) |
| Label | Label displayed for auto-completion. A street number in brackets indicates that the street number does not exist. | STRING(255) | STRING(255) |
| Region1 | Official region. | Not available | STRING(50) |
| Region2 | County. | Not available | STRING(50) |
| Region3 | County. | Not available | STRING(50) |
| Region4 | Other region information. | Not available | STRING(50) |
| Numero | Street number with complement. | STRING(38) | STRING(38) |
| Num | Street number with complement. | STRING(4) | STRING(4) |
| NbNumero or Nbnumero | Number of numbers in the street. | INTEGER(4) | INTEGER(4) |
| valid_num |
1: the number exists in the street. 0: the number does not exist in the street. |
INTEGER(1) | Not available |
| NumSeul | Street number without the number complement. | STRING(4) | STRING(4) |
| ListeNumero | List of available numbers in the street. | STRING(1024) | STRING(1024) |
| TypeVoie | Street type. | STRING(20) | Not available |
| Voie | Street name. | STRING(38) | STRING(150) |
| Suburb | Suburb. | Not available | STRING(50) |
| Complement | Additional address information | Empty | STRING(50) |
| Complement2 | Additional address information 2 | Not available | STRING(50) |
| Saisie | Text input (passed in parameter) used to search the street | STRING(255) | STRING(255) |
| Entreprise | Company name | STRING(38) | UK Only |
| Thoroughfare | Dependant street | Not available | UK Only |
SINGLEV2 error response
| Error type | Request | Response type |
|---|---|---|
Missing Licence parameter |
https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=paris&Taille=38&Pays=FRA |
Empty response |
Empty Licence parameter |
https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=paris&Taille=38&Pays=FRA&Licence= |
Empty response |
| Incorrect licence number | https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=paris&Taille=38&Pays=FRA&Licence={INCORRECT_LICENCE_CODE} |
Empty response |
Missing Adresse parameter |
https://{SERVER_ADDRESS}/SINGLEV2/?Taille=38&Pays=FRA&Licence={LICENCE_CODE} |
400 Bad Request error |
Missing Pays parameter |
https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=paris&Taille=38&Licence={LICENCE_CODE} |
400 Bad Request error |
| Error on a parameter | https://{SERVER_ADDRESS}/SINGLEV2/?Adrese=paris&Taille=38&Pays=FRA&Licence={LICENCE_CODE} |
400 Bad Request error |
Related to