This article describes the POST request for the RESTful Address funneladdress API. Use this endpoint to submit street or address search parameters in the request body and retrieve matching suggestions after selecting a postal code or locality from /funnelpostcode/.
Related Address documentation:
- Address API overview
- Restful funnelpostcode GET request
- Restful funneladdress GET request
- Restful funneladdress response
- Restful Address Swagger documentation
Restful funneladdress POST request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funneladdress/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 | Expected value type | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| CityId | {CITY_ID} |
City ID selected previously. | Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Street | {INPUT} |
Street input. | Mandatory |
| Limit | {INTEGER} |
Maximum number of suggestions returned by the call. | Optional |
| Length | {LENGTH} |
Maximum number of characters allowed. Minimum recommended value: 32. Works only on Latin addresses. |
Optional |
| Langue | {LANGUAGE} |
For Japan only: JP Kanji, JK Katakana, EN English. |
Optional |
Related to