Documentation REST

Geo Adrescheck Nationaal

Summary

Simply use the API to enrich Dutch address data that is entered in your webshop or CRM.

Method

The following methods are defined within the Geo Adrescheck Nationaal.

MethodDescription
https://api.postnl.nl/address/national/v1/geocodeAPI that validates national addresses in a general format (send any of a list of pre-defined fields).

Note: This API supports the POST method.

Call details

Preview the API call buildup below.

Method: https://api.postnl.nl/address/national/v1/geocode

Guidelines

The Geo Adrescheck Nationaal is available in 1 form to implement the address verification in your tooling (webform, CRM etc).

The following method is defined within the Geo Adrescheck Nationaal.

1. General format (send any of a list of pre-defined fields). You can opt to require users to fill in a complete address (with all pre-defined fields that make up an address) or choose to choose a subset of fields.
Unique Dutch addresses can be found based on the PostalCode+HouseNumber+Addition (dependant on the existence of an Addition in the HouseNumber range) or Street+HouseNumber+Addition+City. It can be attractive to use on of these subsets insteads of requiring users to fill out a complete address format. 
To reduce the amount of fields the single line method can be, depending on your preference, even more attractive.

Requests

AttributeMandatoryFormatDescriptionExample
Country String [2]The ISO2 country codesNLD
Street String [0-95]The street name of the delivery address.Siriusdreef
HouseNumber String [0-35]The house number of the delivery address42
Addition String [0-35]House number extensionA
PostalCode String [4-10]Zipcode of the address2132WT
City String [0-35]City of the addressHoofddorp

Response

AttributeFormatDescriptionExample
StreetString [0-95]The street name of the delivery address.Siriusdreef
HouseNumberString [0-35]The house number of the delivery address42
AdditionString [0-35]House number extensionA
PostalCodeString [4-10]Zipcode of the address2132WT
CityString [0-35]City of the addressHOOFDDORP
FormattedAddress3 Strings [0-95]Full formatted addressSiriusdreef 42 A 2132WT HOOFDDORP
rdxCoordinateStrings [10]Rijksdriehoek coordinate199735
rdyCoordinateStrings [10]Rijksdriehoek coordinate307365
latitudeStrings [10]LatLong coordinate52.09061
longitudeStrings [10]LatLong coordinate5.12143

Example

Request

{
    "PostalCode": "2132WT", 
    "City": "Hoofddorp",
    "Street": "Siriusdreef",
    "HouseNumber": "42",
    "Addition": "A"
}

Response

[
  {
    "City": "HOOFDDORP",
    "PostalCode": "2132WT",
    "Street": "Siriusdreef",
    "HouseNumber":42,
    "Addition": "A",
    "FormattedAddress": [
      "Siriusdreef 42 A",
      "2132WT HOOFDDORP"
  }
    ],
    "Geocode": {
      "latitude": 12.345678,
      "longitude": 1.2345,
      "rdxCoordinate": 123456.78,
      "rdyCoordinate": 123456.789
    }
  }
]