There are different ways you can implement this API, depending on how you want to capture your addresses. Select the best option below, and we'll point you in the right direction.

Typedown

Our Typedown search type is designed to allow the user to enter the most general address elements first and, once that has been found, move on to more specific parts of the address. The suggestion list is updated a short period after the user stops typing (this period is currently 300 milliseconds). The user can drill down through a series of results to select the required address. Suggestions can be refined as the user types.

Intuitive

Our Intuitive search type is designed to provide accurate suggestions in real-time, that continually update as the user types. The user should provide the address elements in the order that they would appear on an envelope.

Singleline

Our Singleline search type is designed to find an exact or close matching address based on two or three key address elements, entered by the user in the order as they would appear on an envelope. The suggestions can refined with additional input from the user before they select an address from the list.

Verification

Our Verification search type is designed to verify complete addresses. The user supplies a complete address, as it would appear on an envelope, in single or multiple address fields and our solution returns a fully formatted address and a level of confidence.

Singleline

Our Singleline search type is designed to find an exact or close matching address based on two or three key address elements, entered by the user in the order as they would appear on an envelope. The suggestions can refined with additional input from the user before they select an address from the list.

Typedown

Our Typedown search type is designed to allow the user to enter the most general address elements first and, once that has been found, move on to more specific parts of the address. The suggestion list is updated a short period after the user stops typing (this period is currently 300 milliseconds). The user can drill down through a series of results to select the required address. Suggestions can be refined as the user types.

Keyfinder

Our Keyfinder search type is designed to use a search key to find the corresponding address. For example, the user enters a gas or electrical meter number, a Unique Property Reference Number (UPRN) or a Unique Delivery Point Reference Number (UDPRN) and our service will respond with the corresponding address.

Singleline

Our Singleline search type is designed to find an exact or close matching address based on two or three key address elements, entered by the user in the order as they would appear on an envelope. The suggestions can refined with additional input from the user before they select an address from the list.

Typedown

Our Typedown search type is designed to allow the user to enter the most general address elements first and, once that has been found, move on to more specific parts of the address. The suggestion list is updated a short period after the user stops typing (this period is currently 300 milliseconds). The user can drill down through a series of results to select the required address. Suggestions can be refined as the user types.

Verification

Our Verification search type is designed to verify complete addresses. The user supplies a complete address, as it would appear on an envelope, in single or multiple address fields and our solution returns a fully formatted address and a level of confidence.

Keyfinder

Our Keyfinder search type is designed to use a search key to find the corresponding address. For example, the user enters a gas or electrical meter number, a Unique Property Reference Number (UPRN) or a Unique Delivery Point Reference Number (UDPRN) and our service will respond with the corresponding address.

Intuitive

Our Intuitive search type is designed to provide accurate suggestions in real-time, that continually update as the user types. The user should provide the address elements in the order that they would appear on an envelope.

Still unsure? Please contact us to discuss your requirements and see how we can help.

Other things to consider

The table below shows capabilities of the latest version of pro-api. Not all capabilities are available in previous versions. Please contact us to discuss your requirements and see how we can help.

Search type Partial addresses supported Address Enrichment Customizable address formats Fuzzy matching Wildcards
Singleline Yes Yes Yes Yes Yes
Typedown Yes Yes Yes No Yes
Verification No Yes Yes Yes No
CASS No Yes Yes Yes No
Keyfinder No Yes Yes No No
Intuitive Yes Yes No Yes No
Lookup No Yes Yes No No