This article describes the POST request for the RESTful Address funnelpostcode API. Use this endpoint to submit postcode search parameters in the request body and retrieve matching postcode and locality suggestions.
Related Address documentation:
- Address API overview
- Restful funnelpostcode GET request
- Restful funnelpostcode response
- Restful Address Swagger documentation
Restful funnelpostcode POST request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funnelpostcode/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 |
| PostalCode | {POSTAL_CODE} |
Postal code to search for. | Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Extended | {EXTENDED} |
Y or N. Allows you to search with at least 2 digits in the postal code. For France and Belgium only, the grouping of postal codes by municipality is fragmented. |
Optional |
| Limit | {INTEGER} |
Maximum number of suggestions returned by the postcode call. | Optional |
| Filter | {INTEGER} |
1: Postal code and PO box; 2: Postal code and street; 3: Postal code; 4: one suggestion per postal code and city (Malaysia only). |
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