Use the /COMPLV2/ endpoint to retrieve building or apartment complement details for an address selected from a /SINGLEV2/ response. Pass the IDVoie and IDNum values returned by /SINGLEV2/ as input.
GET request
Endpoint
https://{SERVER_ADDRESS}/COMPLV2/?IDVoie={STREET_ID}&IDNum={NUM}&Taille={LENGTH}&Pays={COUNTRY_CODE}&Filter={FILTER}&Licence={LICENCE_CODE}Replace the values in braces with your own information.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Address of the DQE server that will process the data. | Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account or token generated by oauth2. | Mandatory |
| IDVoie | {STREET_ID} |
Street ID returned by /SINGLEV2/. |
Mandatory |
| IDNum | {NUM} |
Street number ID returned by /SINGLEV2/. |
Mandatory |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Taille | {LENGTH} |
Character limit for the address. Works only on Latin addresses. | Optional. Default: 38. Recommended minimum: 32. |
| Filter | {FILTER} |
USA only. Filters complement types (e.g. apt). |
Optional |
POST request
Endpoint
https://{SERVER_ADDRESS}/COMPLV2/Add the parameters below in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code assigned to your account or token generated by oauth2. | Mandatory |
| IDVoie | {STREET_ID} |
Street ID returned by /SINGLEV2/. |
Mandatory |
| IDNum | {NUM} |
Street number ID returned by /SINGLEV2/. |
Mandatory |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Taille | {LENGTH} |
Character limit for the address. Works only on Latin addresses. | Optional. Default: 38. Recommended minimum: 32. |
| Filter | {FILTER} |
USA only. Filters complement types. | Optional |
Response
Success response
The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains one address complement (building, apartment, etc.).
{
"1": {
"Batiment": "CHRISTY VIENER, FL 4",
"CodePostal": "10020-2400"
},
"2": {
"Batiment": "FL 4",
"CodePostal": "10020-2402"
},
"Latitude": "40.758224999999996",
"Longitude": "-73.977428"
}Example with optional fields:
{
"1": {
"Batiment": "BATIMENT A"
},
"2": {
"Batiment": "BATIMENT B"
},
"iris": "5101",
"ilot": "1330015",
"Longitude": "2.36184219788525",
"Latitude": "48.8190056386452",
"Status_IrisIlot": "INSEE"
}| Key | Value | France | International |
|---|---|---|---|
| Batiment | Building or apartment complement label. | STRING(38) | STRING(150) |
| CodePostal | Postal code. | Not available | STRING(10) |
| Longitude | Longitude of the address. | DECIMAL(18) | DECIMAL(18) |
| Latitude | Latitude of the address. | DECIMAL(18) | DECIMAL(18) |
| Status_IrisIlot | Geocoding status for Iris/Ilot (France only, requires licence option). | STRING | Not available |
| ilot | Ilot code (France only, requires licence option). | STRING | Not available |
| iris | Iris code (France only, requires licence option). | STRING | Not available |
Error response
| Error type | Response type |
|---|---|
Missing or incorrect Licence parameter |
Empty response |
Missing IDVoie parameter |
400 Bad Request |
Missing IDNum parameter |
400 Bad Request |
Missing Pays parameter |
400 Bad Request |
Swagger documentation
See also
Related to