There are two main endpoints included in the Verify product, this is Check and Verify.

Check Address

The Check endpoint enables you to test and integrate the Autoaddress service within your workflow while protecting full address details at no cost.

Each request is securely processed on our servers, where performance statistics are collected to help you evaluate the service. All requests are logged to your account, and over time you can access detailed reports in the Account Centre to monitor and review usage.

See the Check Address documentation for full details.

Verify Address

The Verify endpoint allows you to send an address for validation. It attempts to match the provided address against our address database and returns:

Recommended action – guidance on how to handle the address based on the match result.
Matched address – the standardized address we found.
Original input address – exactly what was submitted.
Match quality – how well the input address matches a known address.

This API is designed to help ensure address accuracy, improve user experience, and reduce delivery or service errors. The Verify API is optimized for Irish and UK addresses but it is available for other countries.

See the Verify Address documentation for full details.

How to Use

The Verify API always returns an address object, which may contain the matched address or the user’s entered address. This object should always be used, regardless of the recommended action, as it can include partially matched elements or corrections such as spelling adjustments.

The action value tells you how the address should be handled. Your application should follow this guidance to decide what happens next.

Accept Action

The address has been confidently matched and verified.

Use the returned address object.
The address object will always have an id.
May have minor amendments (formatting, casing).

Suggest Action

A significant change was detected between the input and the matched address.

Use highlights, returned in the address, to point out the differences.
Show both the input.label and address.label to the user and allow them to select which address they would like to continue with.
The address object will always have an id.

Confirm Action

The address may have only partially matched the input address or not matched at all.

Use highlights, returned in the address, to point out the differences.
Show the address.label and form.message.value to the user and allow them to select whether they wish to continue with this address.
The address object may or may not have an id depending on how well the input was matched.

Reject Action

The address has been matched but falls outside of your allowed locations or address types as set in your integration settings in the Account Centre.

The response will contain form.message.value which will describe the reason the address has been rejected. Display this to the user along with the address.label.
Example: PO Box addresses when PO Boxes are disabled in your settings.

Example Implementation Flow

Collect the address from the user or your preferred source.
Send the address to the Verify endpoint.
Read the action value from the response.
Follow the guidance above based on the returned action.
If action is suggest or confirm, highlight the changes to the user using the address.highlights and address.label.

Best Practices

Use the information provided in the address object when displaying or saving an address.
If action is Suggest or Confirm, use the address.highlights to display what has changed to the user.
Use the address.label to display the address.
Map the address.highlights to the structure of the label to accurately highlight the differences to the user.
Provide the country parameter in requests to limit what country to search in.

Authentication

The verify API is authenticated using our standard authentication method. For details on how to authenticate and create a token, see our Authentication documentation.

Request Structure

The verify API supports both Get and Post requests. The parameters can be sent in the URL or the body.

Endpoint

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

Parameters

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/town name.
`region`	String	No	State, province, or county.
`country`	String	Yes	ISO country code or country name.
`language`	String	No	Language to search in. If not provided or empty, search in all languages.

Sample Requests

Get

curl --location 'https://api.autoaddress.com/3.0/verify?addressLine=8+silver+birches&city=Dunboyne&country=IE&language=en&region=Co.+Meath&token=YOUR_TOKEN'

Post

curl --location 'https://api.autoaddress.com/3.0/verify' -d 'addressLine=8 silver birches&city=Dunboyne&country=IE&language=en&region=Co. Meath&token=YOUR_TOKEN'

Response Structure

In this example, the input address has been successfully verified and the service returns an action of Accept. For more detailed information, see our detailed examples link here.

Sample Response

{
  "type": "verify",
  "action": "Accept",
  "form": {
    "language": "en",
    "message": {
      "id": 1010,
      "severity": "Information",
      "value": "Address verified, please note differences"
    }
  },
  "information": {
    "addressAmended": true,
    "complete": true,
    "matchLevel": "Building",
    "postcodeAmended": true,
    "subBuilding": "None",
    "status": "Verified"
  },
  "input": {
    "lines": [
      {
        "key": "AddressLine1",
        "value": "8 silver birches"
      }
    ],
    "city": {
      "value": "Dunboyne"
    },
    "region": {
      "value": "Co. Meath"
    },
    "postcode": {
      "value": ""
    },
    "country": {
      "language": "en",
      "value": "Ireland",
      "iso": "IE"
    },
    "label": [
      "8 silver birches",
      "Dunboyne",
      "Co. Co. Meath",
      "IRELAND"
    ]
  },
  "address": {
    "id": "IE1701984269",
    "language": "en",
    "charset": "Latn",
    "variation": "V",
    "lines": [
      {
        "key": "AddressLine1",
        "value": "8 Silver Birches"
      },
      {
        "key": "AddressLine2",
        "value": "Millfarm"
      }
    ],
    "city": {
      "value": "Dunboyne"
    },
    "region": {
      "value": "Co. Meath"
    },
    "postcode": {
      "value": "A86 VC04"
    },
    "country": {
      "language": "en",
      "value": "Ireland",
      "iso": "IE"
    },
    "label": [
      "8 Silver Birches",
      "Millfarm",
      "Dunboyne",
      "Co. Meath",
      "A86 VC04",
      "IRELAND"
    ],
    "highlights": [
      [],
      [
        0,
        8
      ],
      [],
      [],
      [
        0,
        8
      ],
      []
    ]
  },
  "data": {
    "location": {
      "latitude": 53.420761,
      "longitude": -6.466002,
      "crs": "EPSG:4258",
      "accuracy": "BUILDING"
    }
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.autoaddress.com/3.0/verify?addressLine=8+silver+birches&city=Dunboyne&country=IE&language=en&region=Co.+Meath&token=YOUR_TOKEN",
      "title": "self"
    }
  ]
}

Getting Started with Verify