The Verify API will return a message object that will describe how well the given address has been matched. The purpose of this message is to help you communicate to the user if there is an issue with the address that's been passed.

This document will outline the messages that can be returned by the API, the unique ID for each and some examples.

ID: 1000
Message: "Address verified"
Severity: Information
Example: 8 Silver Birches, Millfarm, Dunboyne, Co. Meath A86 VC04

ID: 1010
Message: "Address verified, please note differences"
Severity: Information
Example: 25 Castle Park, Carrick on Suir, Co. Tipperary

ID: 2000
Message: "We found a close match, please note differences."
Severity: Warning
Example: 8 Silver Birches, Millfarm, Meath

ID: 2010
Message: "To ensure timely delivery we suggest using this verified address."
Severity: Warning
Example: 8 Silver Birches, Millfarm, Dunkirk, Co. Meath

ID: 2020
Message: "Did you mistype the building number? We found a close match."
Severity: Warning
Example: 88 Silver Birches, Millfarm, Dunboyne, Co. Meath, A86 VC04

ID: 2030
Message: "Did you mistype the street name? We found a close match."
Severity: Warning
Example: 8 Silver Cloud, Millfarm, Dunboyne, Meath, A86 VC04

ID: 2040
Message: "We changed the address to match Eircode."
Severity: Warning
Example: 8 Silver Cloud, Millfarm, Enniscorthy, Wexford, A86 VC04

ID: 3000
Message: "Could not verify this address. Are you sure it is correct?"
Severity: Warning
Example: 8 Delivermefrom Lane, Wallingfarm, Dunkirk, Wexford

ID: 3010
Message: "Did you forget the unit or apartment number?"
Severity: Warning
Example: 82 Capel St, Dublin 1

ID: 3020
Message: "Could not find '{0}'. Please check the address is correct."
Severity: Warning
Example: Flat 66, 82 Capel St, Dublin 1

ID: 3030
Message: "Are you sure you haven't forgotten a unit or apartment number?"
Severity: Warning
Example: 52 Kennilworth Square South, Dublin 6

ID: 3060
Message: "Could not find street name. Please check the address is correct."
Severity: Warning
Example: 52 Kennilworth Gardens, Dublin 6

ID: 3070
Message: "The address appears to be incomplete. Please check the address is correct."
Severity: Warning
Example: Silver Birches, Millfarm, Dunboyne, Co. Meath

ID: 3080
Message: "To ensure timely delivery we suggest providing your Eircode."
Severity: Warning
Example: Curelaim, Turlough, Castlebar, Co. Mayo

ID: 4000
Message: "We can't deliver to this address, please provide an alternative."
Severity: Error
Example: Location is not selected in Supported countries list in Integration settings

ID: 4010
Message: "We can't deliver to PO boxes. Please provide an alternative address."
Severity: Error
Example: Display PO Box addresses setting is turned off in Integration settings