Documentation REST
Adrescheck Basis Nationaal
Summary
Simply use the API to check Dutch address data that is entered in your webshop or CRM.
Method
The following methods are defined within the Adrescheck Basis Nationaal
| Method
| Description
|
| https://api.postnl.nl/address/national/basic/v1/postalcode | Postalcode: If the requested address exists within a postal code range this API returns status, streetname, city and area code based on requested postalcode and housenumber. |
| https://api.postnl.nl/address/national/basic/v1/easycheck | Citystreetname: This API returns NEN-streetname and NEN City name based on requested postalcode. |
Call details
- Use strings.
- The city name accepts formal entries, like ”‘s-Gravenhage”. It also accepts most locally accepted variations, like “Den Haag”.
- In case of street names, this product uses NEN address formats. One of the protocols abbreviates street names to a maximum of 24 characters. In those cases it transforms “straat”, “laan” and “weg” into respectively “str”, “ln” and “wg”. Shorter street names are written in full.
- Expect multiple output in some cases. For instance “Kerkstraat 1 Rijswijk” returns addresses in two different cities: “Rijswijk ZH” and “Rijswijk GLD“. Similarly, “1060NN” returns six streets in one city: “Ben Alder”, “Ben Avon”, “Ben Hope”, “Ben Lawers”, “Ben Nevis” and “Ben Wyvis”, all situated in the city of “Amsterdam” .
- The 6 digit Postal code format is without spaces; 1000AA is valid, where 1000 AA leads to an error or empty result.
- The telephone area code consists of 3 or 4 digits.
Please consider (1) field input capital insensitive and (2) field names capital sensitive.
Parameters
1 postalcode - https://api.postnl.nl/address/national/basic/v1/postalcode
The following input parameters should be used:
| Attribute | Mandatory | Description | Example |
| postalcode | M | The postalcode of the delivery address | 2592AK |
| housenumber | M | The house number of the delivery address | 25 |
The following output parameters are returned:
| Attribute | Description | Example |
| status | Equals 1 if address exists in range, equals 0 if not | 1 |
| streetName | The street name of the delivery address | Prinses Beatrixlaan |
| houseNumber | The house number of the delivery address | 23 |
| postalCode | Postalcode of the address | 2595AK |
| city | City of the address | ‘S-GRAVENHAGE |
| areaCode | Telephone area code | 070 |
2 citystreetname - https://api.postnl.nl/address/national/basic/v1/citystreetname
The following input parameters should be used:
| Attribute | Mandatory | Description | Example |
| postalcode | M | The Postalcode of the delivery address | 2595AK |
The following output parameters are returned:
| Attribute | Description | Example |
| streetName | The street name of the delivery address | Prinses Beatrixlaan |
| city | City of the address | ‘S-GRAVENHAGE |