API

Address.view

Get an address based on its unique combination of postcode, houseNumber and house number addition.

Coordinate and surfaceArea values are null values if no location is known, i.e. if the address is a PO Box.

You must always check the houseNumberAddition result field, as a successful response is also returned if only the input addition isn't found.

Parameters

applicationKey: string

The application you wish to authenticate with

applicationSecret: string

The secret you wish to authenticate with

postcode: string

Four number neighborhood code plus two character letter combination

houseNumber: int

House number, within a range of 1 to 99999.

houseNumberAddition: string

Addition to the house number, required to uniquely define an address with multiple additions.

Example XML-RPC request

Request an address validation by POSTing the following XML to /xmlrpc:

<?xml version="1.0"?>
<methodCall>
  <methodName>Address.view</methodName>
  <params>
    <param>
      <value><string>2eTpkU*****…</string></value>
    </param>
    <param>
      <value><string>Xj4kGq*****…</string></value>
    </param>
    <param>
      <value><string>2012ES</string></value>
    </param>
    <param>
      <value><int>30</int></value>
    </param>
  </params>
</methodCall>

Returns

street: string

Street name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length. Filled with "Postbus" in case it is a range of PO boxes.

houseNumber: int

House number of a perceel. In case of a Postbus match the house number will always be 0. Range: 0-99999

houseNumberAddition: string

Addition of the house number to uniquely define a location. These additions are officially recognized by the municipality. Null if addition not found (see houseNumberAdditions result field).

postcode: string

Four number neighborhood code (first part of a postcode). Range: 1000-9999 plus two character letter combination (second part of a postcode). Range: "AA"-"ZZ"

city: string

Official city name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length.

municipality: string

Municipality name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length. Examples: "Baarle-Nassau", "'s-Gravenhage".

province: string

Official name of the province, correctly cased and with dashes where applicable.

rdX: int

X coordinate according to Dutch Rijksdriehoeksmeting "(EPSG) 28992 Amersfoort / RD New". Values range from 0 to 300000 meters. Null for PO Boxes.

rdY: int

Y coordinate according to Dutch Rijksdriehoeksmeting "(EPSG) 28992 Amersfoort / RD New". Values range from 300000 to 620000 meters. Null for PO Boxes.

latitude: double

Latitude of address. Null for PO Boxes.

longitude: double

Longitude of address. Null for PO Boxes.

bagNumberDesignationId: string

Dutch term used in BAG: "nummeraanduiding id".

bagAddressableObjectId: string

Dutch term used in BAG: "adresseerbaar object id". Unique identification for objects which have 'building', 'house boat site', or 'mobile home site' as addressType.

addressType: string

Type of this address. See reference for possible values.

purposes: array of strings

List of all purposes (Dutch: "gebruiksdoelen"). Null or an array of text values. See reference for possible values.

surfaceArea: int

Surface in square meters. Null for PO Boxes.

houseNumberAdditions: array of strings

List of all house number additions having the postcode and houseNumber which was input.

Example response

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>street</name>
            <value><string>Julianastraat</string></value>
          </member>
          <member>
            <name>houseNumber</name>
            <value><int>30</int></value>
          </member>
          <member>
            <name>houseNumberAddition</name>
            <value><string></string></value>
          </member>
          <member>
            <name>postcode</name>
            <value><string>2012ES</string></value>
          </member>
          <member>
            <name>city</name>
            <value><string>Haarlem</string></value>
          </member>
          <member>
            <name>municipality</name>
            <value><string>Haarlem</string></value>
          </member>
          <member>
            <name>province</name>
            <value><string>Noord-Holland</string></value>
          </member>
          <member>
            <name>rdX</name>
            <value><int>103242</int></value>
          </member>
          <member>
            <name>rdY</name>
            <value><int>487716</int></value>
          </member>
          <member>
            <name>latitude</name>
            <value><double>52.37487801</double></value>
          </member>
          <member>
            <name>longitude</name>
            <value><double>4.62714526</double></value>
          </member>
          <member>
            <name>bagNumberDesignationId</name>
            <value><string>0392200000029398</string></value>
          </member>
          <member>
            <name>bagAddressableObjectId</name>
            <value><string>0392010000029398</string></value>
          </member>
          <member>
            <name>addressType</name>
            <value><string>building</string></value>
          </member>
          <member>
            <name>purposes</name>
            <value>
              <array>
                <data>
                  <value><string>office</string></value>
                </data>
              </array>
            </value>
          </member>
          <member>
            <name>surfaceArea</name>
            <value><int>643</int></value>
          </member>
          <member>
            <name>houseNumberAdditions</name>
            <value>
              <array>
                <data>
                  <value><string></string></value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

References