Address Validation REST provides different address search workflows, depending on the dataset and your requirements.
search-address typeWith this method, the address is entered on a single line. This is the quickest and most efficient way to enter an address; allowing for partial address entry to achieve a complete and validated address.
verify-address typeWith this method, the whole address is entered first (similar to online address forms with multiple fields for address, city and postal code) and then passed on for searching. It requires the user to enter the complete address and works with your existing address forms.
| Search Type | Example |
|---|---|
| Full address known | Enter the premises number followed by the postcode: 35, de238lh The correct address is returned: 35 Douglas Street DERBY DE23 8LH |
| Sub-premises known | If the full address contains known sub-premises, enter the sub-premises followed by the premises number, then the postcode: 2, 18, eh105ly The correct address is returned: 18/2 Morningside Drive EDINBURGH EH10 5LY |
| Postcode not known | If the postcode is not known, enter the premises number and street name followed by the locality: 1 fairfield st, leeds The correct address is returned: 1 Fairfield Street LEEDS LS13 3DX |
| Only street name known | If the street name only is known, entering the street will return a picklist allowing further refinement. Address Validate API can handle abbreviated street descriptors such as st, rd, ave or cl. Enter Fairfield Street to view a list of every street of that name in the country. |
| Character missing from address | If one character is missing from the address, the unknown character can be replaced with a question mark. Enter 12 ?arden rd, kendal and the correct address is returned: 12 Garden Road KENDAL Cumbria LA9 7ED |
| Address contains spelling mistake | Entering an address that contains one or more spelling errors can still return the correct address. Entering 2 joyland rd, bromley will still return the correct address: 2 Boyland Road BROMLEY BR1 4QF |
| Incomplete address element | If you only have partial address information, you can replace the remainder of an address element with an asterisk. Entering church rd, winte* will display a picklist of Church Roads in all places beginning with 'winte'. |
| Incomplete address element | Sometimes it is helpful to tag a part of the search string to let Address Validate API know which part of the address it is. Searching on king*@s, bolton tells Address Validate API to display a picklist of streets that begin with "king…" in Bolton. |
| All organisation types in location | Enter *bank, brighton to view a list of all the banks in Brighton. |
| Scenario | verifylevel | Example |
|---|---|---|
| Verified address found | Verified | 12 Dakota Drive Zebulon NC 27597-6670 |
| Match to multiple results found | Multiple | 200 Rodeo Drive Beverly Hills CA |
| Not enough information provided | None | Rodeo Drive CA |
| No property number provided | StreetPartial | Rosemont Road North Jackson OH 44451-9631 |
| More than one apartment exists at provided address | PremisesPartial | 1825 South Main Street Walnut Creek CA 94595 |
| No city or ZIP information provided | InteractionRequired | 1664 Fyler Rd Lot 1 NY |
verify-address methodWith this method, the whole address is entered first (similar to online address forms with multiple fields for address, city and postal code) and then passed on for searching. It requires the user to enter the complete address and works with your existing address forms.
| Scenario | verifylevel | Example |
|---|---|---|
| Verified address found | Verified | 825 Dusseault Crt Yellowknife NT X1A 2Z4 |
| Match to multiple results found | Multiple | 14 Arnold Ave ON |
| Not enough information provided | None | NoStreet NoTown |
| No property (premise/building) information provided | StreetPartial | 38th Ave W Vancouver BC V6M 1R9 |
| More than one apartment exists at provided address | PremisesPartial | 351 Saguenay Dr Saskatoon ON S7K 5T4 |
| Street name provided is incorrect/postal code is incomplete | InteractionRequired | 151 David RdNepean ON K2G |