Use this API to get real-time information about all 7.8 million Dutch households to gain customer insights and increase your conversion rates through personalized and relevant communication.
Methods and endpoints
Input headers for API
|Header key||Header value||Mandatory/optional|
Input fields for API body
|HouseNumber||Mandatory||String or Number [1-5]||123 (only numerical values allowed)|
|HouseNumberAddition||Optional||String [0-6]||A / a / a2|
|Selection||Mandatory||List of strings||["Segments", "LivingArea", "CommercialActivity"]|
Explanation of field ‘Selection’
With the Selection input field, you can select the fields you want to get. Requesting fewer fields can be cheaper.
This input field expects an array of strings, where each string contains the name of the output field you are interested in. There are two extra options, you can also select a full domain by using the name of the domain instead of listing all its corresponding fields. Second you can use the string “All” to request all available fields. In the table below (under section ‘expected output from API’) all the field names are listed. If you mistype or use a fieldname that is not listed, it will be ignored.
The address domain is free and is always included in the output.
Expected output from API
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
Possible error codes
|Error code||Status message|
|200||JSON response with requested data.|
Address is not a residential address. Example:
Error on customer-side. Example:
|500||Error on PostNL side.|
You can find all response labels, including their descriptions in the downloadable documentation.