Use this Restful endpoint to validate and correct a completed postal address after entry, using the POST method.
Related Address documentation:
- Address API overview
- Restful Check Address GET request
- Restful Check Address response
- Restful Address Swagger documentation
Restful Check Address POST request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/checkaddress/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. | Mandatory |
| Address | {INPUT} |
Character string containing the recomposed address with the pipe character as separator, in the form: additional address|address|dependent locality or state|zip code|city. Pipes are mandatory even when values are empty. |
Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Length | {LENGTH} |
Character limit for the Address response field. Works only on Latin addresses. |
Optional. If not specified, default is 38. Recommended minimum value: 32. |
| Suggestion | {PROP} |
France only. Allows multiple correction options instead of one. Value O: the JSON response contains several records numbered from 1 to n. Value S: the JSON response includes a suggestion when Modification=O. |
Optional |
| Modification | O |
Indicates which field of the address has been adjusted by RNVP: additional address, address, dependent locality, zip code, or city. | Optional |
| Version | {VERSION_JSON} |
1.1: indicates the nature of geocoding on the address when subscribed, France only. 2: returns the list of additional address information in a dedicated ListeComplement field. |
Optional |
| Segmentation | {Segmentation} |
Adds Finesis information when the value is O: Sprofil, Sportrait, and Ssegment. |
Optional. If not specified, default is N. |
Related to