API Integration
Overview
API Overview
These documents describe the Autoaddress 3.0 API, including authentication, HTTP resources and recommended best practices. This content is intended fo...
Authentication
All calls to the Autoaddress 3.0 API must be authenticated. This can be done by passing either an API key or token in a request. A User-Agent is requi...
Create Token
The CreateToken endpoint is used to exchange your API key for a short-lived access token. We recommend you create them on your server to grant access ...
Capture
Getting Started with Capture
You will first need to authenticate the session to create a token using the createtoken endpoint. To call this endpoint, you will need to pass a val...
Autocomplete
The Autocomplete endpoint is used to retrieve a list of suggested addresses from a search query. Please read API Overview first. https://api.autoadd...
Search
The Search endpoint is used to retrieve a list of suggested addresses from a search query. We recommend that you read our API Overview guide first. ...
Drilldown
The Drilldown endpoint is used to retrieve further addresses that are contained in an area such as a building or street. Please read API Overview fi...
Lookup
The Lookup endpoint is used to retrieve a complete address using parameters returned from an API call to another endpoint such as Autocomplete or Dril...
GetData
The Get Data endpoint is used to retrieve additional information about an address. The additional data is customer specific. Please read API Overview...
Verify
Getting Started with Verify
There are two main endpoints included in the Verify product, this is Check and Verify . The Check endpoint enables you to test and integrate the ...
Verify Address
When you call the Verify endpoint, the API returns a JSON object containing details about: Recommended action. The matched and input addresses. Any ...
Detailed Examples
This section provides an example of the Check API and the response returned. The response returned is a simple check response which is used to colle...
Implementation
This section demonstrates how to call the Check API endpoint and how this is reflected on the Account Centre. The response returned will be a succes...
Check Address
The Check API provides a simple free way for you to evaluate the Autoaddress service. It is called with the same parameters as the Verify API , but...