Check Address

Overview

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 does not return any response information, nor does it consume credits.

The goal of the Check API is to let you integrate and test the service in your workflow without exposing full address details. The request is processed on our servers and we gather statistics so that you can evaluate the Autoaddress service. Every request made is logged to your account, and over time you will be able to review detailed reports in the Account Centre.

Purpose

Allow you to test the Verify API workflow with real data.
Provide a no-cost way to call the service and see how well it performs before committing.
Collect statistics that can be reviewed in the Account Centre reports.

Authentication

The Check API uses the same authentication as Verify. You can generate an access token using the Create Token endpoint. See Authentication for details.

Endpoint

https://api.autoaddress.com/3.0/check

Parameters

The Check API accepts the same parameters as Verify.

Parameter	Type	Required	Description
`token`	String	Yes	Access token obtained from the Create Token endpoint. Token can also be passed in the body of the request.
`addressLine`	String	Yes(1+)	One or more lines of the address. Multiple addressLine parameters can be provided.
`city`	String	No	The city or locality.
`region`	String	No	The region, county, or state.
`country`	String	Yes	Country code (ISO-2 format).
`language`	String	No	Language to return result in. Defaults to all if not provided.

Response

The Check API response is not intended to be used. This can be called but will only return the response as defined below. No address object, action, or match information is returned.

{
  "type": "check"
}

Log into the Account Centre and over time see how Autoaddress can help with your address data.

Reports in Account Centre

After calling the Check API over time, you can log into your account in our Account Centre to review how well the service is performing. The reports provide:

Verification Statistics
- Full Address Match rate
- Building Level Match rate
- Non-unique Address rate
- Rejected Address rate
- Incomplete Address rate
- Address Not Matched rate
Amendments
- Postcode amended
- Address amended
- Address and Postcode amended
Warnings
- Incomplete Address
- Sub-building missing or unmatched
- Non-unique Address
- Rejected Address
Actions Distribution
A pie chart showing how many addresses were Accepted, Suggested, Confirmed, or Rejected.

These reports mirror the full output of the Verify API but are presented in aggregate so you can measure the effectiveness of the service at scale.