API documentation
Klant in beeld Premium v1
Summary
The klant in beeld Premium API is exclusively available for customers with a parcel contract with PostNL. Use this API to get real-time information about all 473 thousand Dutch postal codes to gain customer insights on e-commerce and delivery features. And increase your conversion rates through personalized and relevant communication.
Methods and endpoints
| Method | Endpoint |
| POST | https://api.postnl.nl/address/national/insight/v1/premium |
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 [0-6] | A / a / a2 |
| Selection | Mandatory | Array of strings | ["Segments", "LivingArea", "CommercialActivity"] |
Explanation of field ‘Selection’
With the Selection input field, you can select the fields you want to get.
This input field expects an array of strings, where each string contains the name of the output field you are interested in. There is an extra option: you can also select a full domain by using the name of the domain instead of listing all its corresponding fields. If you mistype or use a fieldname that is not listed, it will be ignored. Please be aware that an additional fee will be charged if more than 10 different fields (basic and premium combined) are requested during the license period.
Output parameters
The expected output depends on the fields you have selected, the Address domain is always returned.
You can find all output fields, including their descriptions and formatting in the downloadable documentation.
Example request & response
| Request | Response | Response translated to insights |
{ "PostalCode": "2521CA", "Selection": [ "Frequency", "Loyalty", "Electronics"] } | { "Address": { "PostalCode": "2521CA" }, "ParcelDelivery": { "Frequency": { "Frequency1": 4, "Frequency2": 8, "Frequency3": 0, "Frequency4": 12, "Frequency5": 12, "Frequency6": 17, "Frequency7": 46 },
"Loyalty": { "Loyalty1": 33, "Loyalty2": 8, "Loyalty3": 8, "Loyalty4": 25, "Loyalty5": 25 } }, "AreasOfInterest": "Electronics": { "Electronics1": 16, "Electronics2": 20, "Electronics3": 64 }
} | Frequency (deliveries per year):
Electronics:
|
Possible error codes
| Error code | Status message |
| 200 | JSON response with requested data. |
| 206 | Address is not a residential address. Example:
{
|
| 4xx | Error on customer-side. Example:
{
|
| 500 | Error on PostNL side. |
Responselabels
You can find all response labels, including their descriptions in the downloadable documentation.