This article describes the POST request for the Address COMPLV2 API. Use this endpoint to submit address complement parameters in the request body and retrieve buildings, apartments or secondary address information after a user has selected an address from /SINGLEV2/.
Related Address documentation:
- Address API overview
- SINGLEV2 GET request
- COMPLV2 GET request
- COMPLV2 response
- Address Swagger documentation
COMPLV2 POST request
Endpoint
https://{SERVER_ADDRESS}/COMPLV2/The value {SERVER_ADDRESS} is the address of the DQE server that will process the data.
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} |
Unique street ID returned by the /SINGLEV2/ command. |
Mandatory |
| IDNum | {NUM} |
Number in the street. | Mandatory |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Taille | {LENGTH} |
Character limit for the address. Works only on Latin addresses. | Optional. If not specified, default is 38. Recommended minimum value: 32. |
| Filter | {FILTER} |
For the United States: filters the complements returned in the response. | Optional |
Related to