Postcode API

Implementation Checklist

Ensure that your plugin or custom integration of our API is functioning properly by completing the checks on this page. Update the following selection to see checks that are relevant to your situation.

I am a

Using the following Api's

With implementation

General

Start a subscription before production use

Please make sure you start a subscription before production use of the API. Check your subscription status in your account. If your account does not have a subscription yet, it will be disabled if you exceed the maximum number of test hits.

Caching API results

Improve the speed and efficiency of your implementation by avoiding repeated look ups of the same address. This also helps limit your subscription costs. You can check how many validations you have performed in your account.

If the number of validations in your account is higher than your expected volume this may indicate a lack of caching in your implementation. Verify your usage against your own server logs and make sure caching is implemented correctly.

How to encode spaces

Please note that spaces must encoded as '%20' (not as '+'). Incorrect encoding of parameters can lead to incorrect API results.

Autocomplete API

Session header usage

Make sure to use 1 session header per address validation. Using multiple headers per validation or using the same session header for multiple validations can cause higher costs. After using the API for a calendar month log into your account and make sure the number of registered address validations are in line with your expected orders or address validations.

If the number of address validations does not match your expectation check them against your systems logs if this still does not add up, make sure your session headers are correctly set, see session header documentation.

Caching of supported countries

Cache the list of supported countries from get supported countries for a day. There is no need to retrieve this list more frequently.

Verify autocomplete implementation

Verify your Autocomplete implementation by looking up the following address step by step:

  1. Select country "NLD / The Netherlands"
  2. Enter "Amster"
  3. Select "Amsterdam municipality Amsterdam" and make sure "municipality" is shown in the correct language
  4. Add "bestev", make sure only 1 result in Amsterdam is shown, select it
  5. Scroll through the list of buildings and select "More"
  6. Select "Bestevâerstraat 10 3"

Make sure the selected address looks like this:

Bestevâerstraat 10 3 1056 HM Amsterdam

If you run into problems

  • After typing "Amster", make sure that in the line "Amsterdam municipality Amsterdam" the word municipality is in the correct language.
  • If "Bestevâerstraat" is not correctly shown specifically the "â", make sure your website and proxy have its character encoding set-up properly.
  • When you select "Bestevâerstraat" it does not show a list of building numbers. There might be a problem with the autocomplete context, make sure the autocomplete javascript library is initialized correctly.
  • If no new list of building numbers is loaded when you select more, make sure to handle the more addresses button correctly.

Validate API

Make sure API parameters are encoded correctly

Ensure the correct encoding of parameters in validate calls, all parameters must be URL encoded. Test by validating with the following parameters:

Country
NLD
Street
Mevrouw Flührplein
Building
4

Expected result:

Mevrouw Flührplein 4 2685 GD Poeldijk
  • Grade: A
  • Validation Level: Building

Dutch Address API

Test an address with special characters

Ensure the address is displayed correctly when it contains special characters. Do the following address lookup:

Postcode
9113 AN
House number
4
Addition
a

The expected output should look like:

Dokkumerloane 4 a 9113 AN Wâlterswâld

If it is not shown correctly check your page and proxy character encoding setting.

Test house number addition selection

Check whether house number additions are displayed correctly and can be selected. Perform the following lookup:

Postcode
3956 KD
House number
53
Addition
x

Expected result:

r 1 r 2 r 3 r 4 r 5 r 6 r 7 r 8 r 9

This address has a lot of possible additions, make sure they are shown correctly.

WooCommerce plugin

Plugin setup

Make sure the latest version is installed and enter your credentials in the plugin settings page. Confirm the subscription status is "Active" (green).

Test your checkout

Test address validation in the checkout, make sure it works as expected with a known address (for example the business address or home address).

Magento plugin

Plugin setup

Make sure you set up the correct credentials and enter your credentials in the plugin settings page. Confirm the subscription status is "Active" (green).

Test your checkout

Test address validation in the checkout, make sure it works as expected with a known address (for example the business address or home address).