Documentation
Aflevercheck
Summary
Use this API to enrich your Dutch address data with deliverypoint data.
Methods and endpoints
| Method | Endpoint |
| POST | https://api.postnl.nl/address/national/v1/deliverypoint |
Required headers
| Header key | Header value | Mandatory/optional |
| apikey | Your apikey | Mandatory |
| Content-Type | application/json | Mandatory |
Input parameters
| Fieldname | Mandatory/optional | Format | Example | |
| PostalCode | Mandatory | String [6] | 1234AB | |
| HouseNumber | Mandatory | String or Number [1-5] | 123 (only numerical values allowed) | |
| HouseNumberAddition | Optional | String [6] | A / a / a2 |
OR
| Fieldname | Mandatory/optional | Format | Example | |
| City | Mandatory | String [1-35] | Amsterdam | |
| Street | Mandatory | String [1-95] | Dam | |
| HouseNumber | Mandatory | String or Number [1-5] | 123 (only numerical values allowed) | |
| HouseNumberAddition | Optional | String [6] | A / a / a2 |
Output parameters
| Fieldname | Description of attribute | Format (length) |
| City | City of requested address | String [1-35] |
| PostalCode | Postalcode of requested address | String [6] |
| Street | Street of requested address | String [1-95] |
| HouseNumber | Housenumber of requested address | Number [1-5] |
| HouseNumberAddition | Housenumber addition of requested address if applicable | String [6] |
| FormattedAddress | Full formatted address according to PostNL standard | Array with 2 strings |
| Mailboxes | Number of mailboxes at this address | Number [1-3] |
| DeliveryPoints | Number of delivery points at this address | Number [1-3] |
| LotCode | Type of lot (see table below) | String [1] |
| LotCode | Meaning |
| B | Retirement home |
| E | Family home without garden |
| G | Garage box |
| H | High-rise building |
| L | Lot in development |
| M | Farmhouse |
| N | Non-postal deliverypoint |
| O | Other |
| R | Recreational home |
| S | Houseboat |
| T | House with garden |
| W | Shop |
| X | No official deliverypoint |
Possible error codes
| Error code | Error message |
| 200 | JSON response with requested data.
If address does not exist, you get an empty [] response. |
| 4xx | Error on customer-side. Example:
|
| 500 | Error on PostNL side. |
Example request & response
| Request | Response |
| {
"PostalCode": "1507TN", "City": "", "Street": "", "HouseNumber": "6", "HouseNumberAddition": "" } | [
|