This article describes the POST request for the RESTful Address COMPL API. Use this endpoint to submit address complement parameters in the request body and retrieve additional address details after a user has selected an address from /single/.
Related Address documentation:
- Address API overview
- Restful SINGLE GET request
- Restful COMPL GET request
- Restful COMPL response
- Restful Address Swagger documentation
Restful COMPL POST request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/compl/The value {SERVER_ADDRESS} is the address of the DQE server that will process the data.
The value {VERSION} is the API version used for the request.
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 |
| StreetId | {STREETID} |
Street ID of the selected address returned by /single/. |
Mandatory |
| StreetNumber | {STREETNUMBER} |
Street number of the selected address returned by /single/. This value can be empty. |
Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Length | {LENGTH} |
Character limit for the address. Works only on Latin addresses. | Optional. If not specified, default is 38. Recommended minimum value: 32. |
| Search | {SEARCH} |
For the United States: filters the complements returned in the response. | Optional |
Related to