addy

NZ
AU

addy

NZ
AU

Services

Pricing

Documentation

Contact

FAQ

Login

Address APIs

Address Finder API
Address Validation API
Address Details API
Address Discovery API
Postcode Finder API
Geocode Address API
Bounding Box API

Address Validation API

Use the NZ address validation API to clean, standardise and format addresses

Address Validation API


Addy Solutions' Address Validation API, also known as the Address Cleansing API or Address Correction API, will verify, cleanse, standardise and format addresses to deliver complete, accurate and enhanced data. Use Addy Solutions' Address Autocomplete API for real-time address verification and autocomplete to prevent address mistakes at the point of entry.

This page is intended for API developers that would like to integrate with Addy Solutions's address matching API. Visit the address cleansing page to validate your bulk list of customer addresses using an Excel spreadsheet.

Address Validation API Endpoint


URLhttps://api-nz.addysolutions.com/validation
HTTP Request TypeGET

cURL Request


The example below will make a JSON request to validate for "80 Queeen St Aucland Centril" by adding the API key in the request header:

1curl -X GET --header 'Accept: application/json' --header 'addy-api-key: demo-api-key' 'https://api-nz.addysolutions.com/validation?address=80 Queeen St Aucland Centril'
Remember to replace demo-api-key with your own API key.

Validate "80 Queeen St Aucland Centril" using the API key as a query string parameter:

1curl -X GET --header 'Accept: application/json' 'https://api-nz.addysolutions.com/validation?key=demo-api-key&address=80 Queeen St Aucland Centril'
Remember to replace demo-api-key with your own API key.

Request Parameters


ParameterDescriptionTypeRequiredExample
addressAn address to validate, cleanse and formatstringYes80 Queen Street, Auckland
exspellingDisable spelling correction from address matching (default false)booleanNo
exwordDisable extra word removal from address matching (default false)booleanNo
useClosestAddressMatch the nearest possible address when a match cannot be found (default false)booleanNo
callbackJSONP callback function namestringNocallback123

Response Properties


PropertyDescriptionTypeExample
addressValidated addressaddress details

See Address Details API

alternativesArray of alternative address matchesaddress array[{address},{address}]
reasonNotification message when the address could not be matched or when multiple addresses are returned that requires manual validationstringNo matches found

Response Example: "80 Queeen St Aucland Centril" validation criteria

https://api-nz.addysolutions.com/validation?key=demo-api-key&address=80 Queeen St Aucland Centril
{
  "address": {
    "id": 2417575,
    "dpid": 1540203,
    "linzid": 2027703,
    "parcelid": 6917300,
    "meshblock": 438102,
    "number": "80",
    "numberfull": "80",
    "numberdisplay": "80",
    "rdnumber": "",
    "alpha": "",
    "unittype": "",
    "unitnumber": "",
    "floor": "",
    "street": "Queen Street",
    "suburb": "Auckland Central",
    "city": "Auckland",
    "mailtown": "Auckland",
    "territory": "Auckland",
    "region": "Auckland",
    "postcode": "1010",
    "building": "",
    "full": "80 Queen Street, Auckland Central, Auckland 1010",
    "displayline": "80 Queen Street",
    "address1": "80 Queen Street",
    "address2": "Auckland Central",
    "address3": "Auckland 1010",
    "address4": "",
    "type": "Urban",
    "boxbagnumber": "",
    "boxbaglobby": "",
    "x": "174.766408",
    "y": "-36.846255",
    "modified": "2018-01-22",
    "paf": true,
    "deleted": false
  },
  "alternatives": [],
  "reason": null,
  "foundPrefix": false,
  "prefix": ""
}

Response Example: "80 Queen Street" validation criteria with multiple valid matches

https://api-nz.addysolutions.com/validation?key=demo-api-key&address=80 Queeen St
{
  "address": {
    "id": 2417575,
    "dpid": 1540203,
    "linzid": 2027703,
    "parcelid": 6917300,
    "meshblock": 438102,
    "number": "80",
    "numberfull": "80",
    "numberdisplay": "80",
    "rdnumber": "",
    "alpha": "",
    "unittype": "",
    "unitnumber": "",
    "floor": "",
    "street": "Queen Street",
    "suburb": "Auckland Central",
    "city": "Auckland",
    "mailtown": "Auckland",
    "territory": "Auckland",
    "region": "Auckland",
    "postcode": "1010",
    "building": "",
    "full": "80 Queen Street, Auckland Central, Auckland 1010",
    "displayline": "80 Queen Street",
    "address1": "80 Queen Street",
    "address2": "Auckland Central",
    "address3": "Auckland 1010",
    "address4": "",
    "type": "Urban",
    "boxbagnumber": "",
    "boxbaglobby": "",
    "x": "174.766408",
    "y": "-36.846255",
    "modified": "2018-01-22",
    "paf": true,
    "deleted": false
  },
  "alternatives": [
    {
      "id": 3828376,
      "a": "80 Queen Street, Masterton 5810"
    },
    {
      "id": 1220406,
      "a": "80 Queen Street, North Dunedin, Dunedin 9016"
    },
    {
      "id": 2398953,
      "a": "80 Queen Street, Northcote Point, Auckland 0627"
    },
    {
      "id": 1541046,
      "a": "80 Queen Street, Richmond 7020"
    },
    {
      "id": 2261993,
      "a": "80 Queen Street, Te Kuiti 3910"
    },
    {
      "id": 4947299,
      "a": "80 Queen Street, Upper Hutt 5018"
    },
    {
      "id": 1907832,
      "a": "80 Queen Street, Waimate 7924"
    },
    {
      "id": 4350248,
      "a": "80 Queen Street, Waiuku 2123"
    },
    {
      "id": 2358361,
      "a": "80 Queen Street, Westport 7825"
    }
  ],
  "reason": "Review alternative addresses.",
  "foundPrefix": false,
  "prefix": ""
}

Address Cleansing Benefits


Quality Address Data

Given partial addresses with missing suburbs, cities or postcodes, the single, easy to integrate address validation API will standardise and complete your addresses. Addresses are formatted according to NZ Post standards to provide better consistency and enable your business to apply for bulk mail discounts due to a higher statement of accuracy (SOA).

Enhanced Address Data

Detailed information such as region, territory, geocoding and meshblock data is included in each validated address to enhance the benefits of your existing address database. This will enable new capabilities and service offerings, such as better target marketing or provide valuable insights about your customers.

Easily visualise customer addresses by plotting them on a map, using business intelligence tools such as Tableau or Microsoft Power BI Desktop (free). Join your addresses with the Stats NZ Census data (2013, 2018) to get insights on customer demographics such as households, income, age, education and more.

Accurate Address Data

Addy's cleansing engine will indicate the validity of each address when potential duplicates are encountered, and provide alternative address recommendations that can be validated easily.

For example, the incomplete address "80 Queen Street Auckland" has two possible, equally valid matches:

  • 80 Queen Street, Auckland Central, Auckland 1010
  • 80 Queen Street, Northcote Point, Auckland 0627

Addy Solutions provides the ability to choose which address is correct. You can also use a strategy to email customers with unmatched addresses to validate that their address is accurate and allow them to correct it. Read our blog about address cleansing strategies.

Configurable Matching

Addy Solutions' Address Validation API is accurate and highly configurable to meet your unique business requirements. By simply changing a couple of parameters, you can enable or disable features such as fuzzy matching, spelling correction and invalid word removal (people names, business names, legal descriptions).

Sign up

Full support

Sign up

Full support

Address Services

Address AutocompleteAddress CleansingAddress GeocodingPostcode FinderPricingSign inSign up
© 2021 Addy LimitedTerms & Conditions
Made in Auckland, New Zealand
Looking for Addy Australia?