Use the /COMPL/ endpoint as the third step in the funnel address search flow. Retrieve building or apartment complement details for an address selected from an /ADR/ response. Pass the IDVoie and IDNum values returned by /ADR/ as input.
GET request
Endpoint
https://{SERVER_ADDRESS}/COMPL/?IDVoie={STREET_ID}&IDNum={NUM}&Taille={LENGTH}&Instance={VALUE}&Pays={COUNTRY_CODE}&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 /ADR/. |
Mandatory |
| IDNum | {NUM} |
Street number ID returned by /ADR/. |
Mandatory |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Taille | {LENGTH} |
Character limit for the address. | Optional. Default: 38. |
| Instance | {VALUE} |
Allows you to pass a value during the call. | Optional |
POST request
Endpoint
https://{SERVER_ADDRESS}/COMPL/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 /ADR/. |
Mandatory |
| IDNum | {NUM} |
Street number ID returned by /ADR/. |
Mandatory |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Taille | {LENGTH} |
Character limit for the address. | Optional. Default: 38. |
| Instance | {VALUE} |
Allows you to pass a value during the call. | 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": "Town Hall, Tameside Metropolitan Borough Council",
"CodePostal": "M34 2AP"
},
"2": {
"Batiment": "Victoria Park Community Association",
"CodePostal": "M34 2AP"
}
}| Key | Value | France | International |
|---|---|---|---|
| Batiment | Building or apartment complement label. | STRING(38) | STRING(150) |
| CodePostal | Postal code associated with the complement. | Not available | STRING(10) |
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 |