Documentation

Aflevercheck

Summary

Use this API to enrich your Dutch address data with deliverypoint data.

Methods and endpoints

MethodEndpoint
POSThttps://api.postnl.nl/address/national/v1/deliverypoint

Required input for API

FieldnameMandatory/optionalFormatExample
PostalCodeMandatoryString [6]1234AB
HouseNumberMandatoryString or Number [1-5]123 (only numerical values allowed)
HouseNumberAdditionOptionalString [6]A / a / a2

OR

FieldnameMandatory/optionalFormatExample
CityMandatoryString [1-35]Amsterdam
StreetMandatoryString [1-95]Dam
HouseNumberMandatoryString or Number [1-5]123 (only numerical values allowed)
HouseNumberAdditionOptionalString [6]A / a / a2

Expected output from API

FieldnameDescription of attributeFormat (length)
CityCity of requested addressString [1-35]
PostalCodePostalcode of requested addressString [6]
StreetStreet of requested addressString [1-95]
HouseNumberHousenumber of requested addressNumber [1-5]
HouseNumberAdditionHousenumber addition of requested address if applicableString [6]
FormattedAddressFull formatted address according to PostNL standardArray with 2 strings
MailboxesNumber of mailboxes at this addressNumber [1-3]
DeliveryPointsNumber of delivery points at this addressNumber [1-3]
LotCodeType of lot (see table below)String [1]

LotCodeMeaning
BRetirement home
EFamily home without garden
GGarage box
HHigh-rise building
LLot in development
MFarmhouse
NNon-postal deliverypoint
OOther
RRecreational home
SHouseboat
THouse with garden
WShop
XNo official deliverypoint

Possible error codes

Error codeError message
200JSON response with requested data.
If address does not exist, you get an empty [] response.
4xx

Error on customer-side. Example:

{
    "errors": [
        {
           "status": "400",
           "title": "Bad Request",
           "detail": "PostalCode has the wrong format. It should be: 1234AB"
       }
    ]
}

500Error on PostNL side.

Example request & response

RequestResponse
{
     "PostalCode": "1507TN",
      "City": "",
      "Street": "",
      "HouseNumber": "6",
      "HouseNumberAddition": ""
}

[
  {
        "PostalCode": "1507TN",
        "HouseNumber": 6,
        "HouseNumberAddition": "",
        "Street": "Wals",
        "City": "ZAANDAM",
        "FormattedAddress": [
           "Wals 6 ",
        "1507TN ZAANDAM"
      ],
        "Mailboxes": 1,
        "DeliveryPoints": 1,
        "LotCode": "T"
    }
]