Autocomplete Netherlands Parameters
Autocomplete a Dutch address.
Note: This is the documentation for the v2 API which is still in beta.
In case you don't know all of the required parameters, you can use the suggest call to gather them first.
If the input identifies a unique address, all available information about said address is returned.
- To validate if an address has either a streetNumber or a Premise, query through the
streetNumberAndPremise
field. - To validate if an address exists with a certain streetnumber, use the
streetNumber
field. - To validate if an address exists with a certain premise, use both the
streetNumber
andpremise
fields. - Either
streetNumberAndPremise
orstreetNumber
is required. If both are given, onlystreetNumber
is used.
The specials subscription offers extra return fields these are:
- BAG_NUM_ID
- BAG_OPR_ID
- BAG_PND_ID
- BAG_VBO_ID
- BAG_TYPE
- neighbourhood
- district
Required parameters
postalCode
(string): The address's postal code in sixpp format (1000AA)
Optional parameters
streetNumberAndPremise
(string): The address's streetnumber and premise (extension/addition)streetNumber
(string): The address's streetnumberpremise
(string): The address's premise
Authorization
authKey
: This is the Authorization key. You have to add it as a GET parameter.
Your auth key can be found on the CMS.
Available API calls
Autocomplete