Integration can be completed within minutes by simply updating the HTML on your website.

No programming skills such as jQuery or JavaScript is required.

Add Addy Solutions' postal address checker to your ecommerce website in 4 easy steps:

Step 1 - Create a free account

Sign up for a free account to get your own Addy API Key that will be used for address lookup requests.

Step 2 - Add the address finder plugin reference

Add a reference to the autocomplete validation widget at the bottom of your address form page (above the </body> tag).

1<script src="https://www.addysolutions.com/address-lookup/1.6.2/js/addy.min.js?nzKey=demo-api-key&country=nz&loadcss=true" async defer></script>

Step 3 - Tag address fields with a class name

Tag each address field with a unique CSS class name that will tell Addy which fields to use for address searching and which fields to populate once an address selection is made.

For example, to turn a text input field into a predictive address search, simply add the addy-line1 class name to your HTML:

1<input type="text" class="addy-line1" id="address1" />

View all of the HTML Markup and CSS tags.

Step 4 - Release to production

Save and deploy your changes.

Try this live address validation demo in JSFiddle using HTML only:

Makes it fast and easy for users to fill in your address form accurately without typing a single character on a keyboard. Simply enable the location feature in Addy, which will use the built in GPS in a user's mobile device to suggest a list of nearby addresses.

As described in the integration section above (Step 2), change the script by adding the "&enableLocation=true" parameter to the script reference:

1<script src="https://www.addysolutions.com/address-lookup/1.6.2/js/addy.min.js?nzKey=demo-api-key&country=nz&loadcss=true&enableLocation=true" async defer></script>

Additional configuration options are provided to customise how the address validation widget should behave on your website.

URL Parameters

The example below shows the options that are available as URL parameters:

1<script src="https://www.addysolutions.com/address-lookup/1.6.2/js/addy.min.js?nzKey=demo-api-key&country=nz&callback=initAddy&excludeSpelling=false&excludeWord=false&excludeIp=false&maxItems=10&loadcss=true&enableLocation=true&excludePostBox=false&excludeRural=false&excludeUndeliver=false&excludePostcode=0622-1010&includePostcode=0622-1010&excludeRegion=1-2&includeRegion=3-4&excludeTerritory=1-2-3&includeTerritory=5-6-7&tag=sales&uniqueid=12345" async defer></script>

The following class names can be used for instructing the address autocomplete widget to add search and autofill functionality to your address fields.

Secondary address fields

Up to 4 address form fields are supported on the same page, such as shipping and billing addresses.

To add additional address fields requires the "addy-2-line1", "addy-3-line1" or "addy-4-line1" pattern as shown below.