API documentation

Klant in beeld Basic v1

Summary

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

MethodEndpoint
POSThttps://api.postnl.nl/address/national/insight/v1/basic

Required headers

Header keyHeader valueMandatory/optional
apikeyYour apikeyMandatory
Content-Typeapplication/jsonMandatory

Input parameters

FieldnameMandatory/optionalFormatExample
PostalCodeMandatoryString [6]1234AB
HouseNumberMandatoryString or Number [1-5]123 (only numerical values allowed)
HouseNumberAdditionOptionalString [0-6]A / a / a2
SelectionMandatoryList 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

RequestResponseResponse translated to insights



  {

     "PostalCode": "2521CA", 

     "HouseNumber": "3",

     "HouseNumberAddition": "",

     "Selection": [ "PropertyType", "PropertyValuationClassification", "AgeHeadOfHousehold", "Lifestage", "GrossFamilyIncome", " NumberOfPeopleWithIncomeFromWork", "WhizeSegment"]

}

 

 [

    {

        "Address": {

            "PostalCode": "2521CA",

            "HouseNumber": 3,

            "HouseNumberAddition": ""

        },

        "Residence": {

            "PropertyType": 4,

            "PropertyValuationClassification": 7,

            "DeliveryPoint": "Y",

            "PlotType": "T"

        },

        "SocioDemographic": {

            "AgeHeadOfHousehold": 8,

            "Lifestage": 5

        },

        "SocioEconomic": {

            "GrossFamilyIncome": 5,

            "NumberOfPeopleWithIncomeFromWork": 2,

            "Education": 2,

        },

        "Segments": {

            "Segment": "K",

        },

    }

]

 


 PropertyType: Terraced house

PropertyValuationClassification: € 237.500 - € 300.000

DeliveryPoint: One or more deliverypoints at address

AgeHeadOfHousehold: 55 till 60 years

Lifestage: Family with children, eldest child 18 or older

GrossFamilyIncome: More than double the average

NumberOfPeopleWithIncomeFromWork: Two or more incomes from work

Segment: K – Life of Luxury

Possible error codes

Error codeStatus message
200JSON response with requested data.
206

Address is not a residential address. Example:

{
   "errors": [
     {
       "status": "206",
       "title": "Not a Residential Address",
       "detail": "We found this address in our database, but it is not a residential address."
      }
   ]
}

4xx

Error on customer-side. Example:

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

5xxError on PostNL side.

Responselabels

You can find all response labels, including their descriptions in the downloadable documentation.

Download documentation