Skip to main content

Addressfinder API

This is a lightweight web service (REST interface), which provides an easy way to access and use every Addressfinder verification service.

Not a developer? Use Addressfinder's low- and no-code integrations.

Quick start

Make your first API call in minutes: login to your account or sign up for a 30-day free trial to get your credentials and register your domains in the Portal (we include localhost by default).

Usage is billed per successful lookup, not API call.

Authentication

You can authenticate your API calls using two different methods:

  • Include your key and secret inside the HTTP GET request directly.
  • Add the secret in the Authorization headers of the request.

When using public-facing applications or client-side code, it's recommended to use header-based authentication to prevent exposing sensitive credentials in the URL (like your API secret), which could be logged or cached by browsers and intermediary services.

Example API call with the secret key in the headers
curl -H "Authorization: YOUR_API_SECRET" "https://api.addressfinder.io/api/nz/address/autocomplete/?key=YOUR_API_KEY&q=184%20will&format=json&strict=2"

You should only include the secret token for server-to-server API calls.


For browser-based API calls, you will need to register the domain in the Portal.

If you find any bug, have any questions or suggestions please get in touch with us at support@addressfinder.com.

Address APIs

Address Autocomplete API - AU, NZ, INT

Interactive search that returns closely matching addresses which are then selected by the user

Address Metadata API - AU, NZ, INT

Return the full metadata associated with an address selected from the Address Autocomplete API

Address Verification API - AU, NZ

The Address Verification API receives a full address from your system and attempts to match it with a verified address in the Addressfinder database. If successful, it returns the matched address and associated metadata.

Location Autocomplete API - AU, NZ

Interactive search that returns closely matching streets, suburbs and/or states which are then selected by the user

Location Metadata API - AU, NZ

Return the full metadata associated with a location (street, suburb or state) selected from the Location Autocomplete API

Address Reverse Geocode API - NZ

Takes the GPS coordinates (longitude and latitude) and returns the nearest addresses ordered by distance

Points of Interest Autocomplete API - NZ

Interactive search that returns closely matching points of interest and their associated addresses

Points of Interest Metadata API - NZ

Return the full metadata associated with a point of interest selected from the Points of Interest Autocomplete API

Email Verification API

Takes an email address and validates the syntax, the existence and availability of the domain, existence of the email account, and returns a verified state and other metadata

Phone Verification API

Verifies a supplied number through a process which involves syntax and range checks prior to a network check for a connection status