Addy.Address.Service.Standard 1.4.1

Address Validation API for New Zealand Places

Official Site: https://www.addy.co.nz/

Source Code: https://github.com/addynz/Address-Validation-Cleansing-NZ-DotNet-Standard

Make it easy for users to find and validate their address in your .NET Core, C# or VB.NET application.

Address Search API

Call the Address Search API to find and validate addresses using fuzzy matching to eliminate typos and spelling mistakes.

https://www.addy.co.nz/address-validation-nz-website https://www.addy.co.nz/address-finder-and-postcode-api

Address Details API

Call the Address Details API to retrieve address information, such as New Zealand Post’s Delivery Point Identifier (DPID), LINZ’s Street Address ID or longitude / latitude (x / y) coordinates, street names, city names, suburbs, postal codes, territories, regions and more.

https://www.addy.co.nz/address-details-api

Address Validation API

Addy's address validation API, also know as the address cleansing API or address correction API, will verify, cleanse, standardize and format addresses to deliver complete, accurate and enhanced data.

https://www.addy.co.nz/faq/address-cleansing-software https://www.addy.co.nz/address-validation-api

Install NuGet Package

To get started, install the Addy.Address.Service.Standard NuGet package or fork this repository.

The code sample will automatically convert JSON address search responses into DTO/POCO objects.

Sample Code in .NET (C#)

Call the Address Validation API to cleanse and validate NZ addresses:

const string apiKey = "your-api-key";
IRequestFactory requestFactory = new RequestFactory(apiKey);

using (IAddressValidationService validationService = new AddressValidationService(requestFactory))
{
   Console.WriteLine("Type an address to validate/cleanse:");
   var criteria = Console.ReadLine();
   if (string.IsNullOrWhiteSpace(criteria)) return;

   var result = await validationService.AddressValidateAsync(criteria);

   if (result.address == null)
   {
      Console.WriteLine("No match found. " + result.reason);
   }
   else
   {
      Console.WriteLine("Full Address: {0}", result.address.full);
   }
}

Links

Official Addy site: https://www.addy.co.nz/

Address Search API Documentation: https://www.addy.co.nz/address-finder-and-postcode-api