- Notifications
You must be signed in to change notification settings - Fork4
Address finder for websites to verify New Zealand addresses at the point of capture. Code samples are provided for fast and effective integration. Lightweight open source third party libraries are used for calling Addy’s free address finder API. Visithttps://www.addysolutions.com/ for documentation and free address API access.
License
addynz/Address-Lookup
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Create a delightful user experience and remove friction from your online forms, save customers time and increase your conversion rates.
Addresses are standardised at the point of capture, validated against official data sources including the New Zealand Postal Address File (PAF) and Land Information New Zealand (LINZ) database.
Avoid the unnecessary costs of failed deliveries, improve shipping efficiency and ensure parcels arrive first time.
Addy's address lookup use intelligent fuzzy matching for searching. This means that if a typo, invalid suburb or partially correct address is entered, customers can still find the right delivery or billing address.
Create a free accounthttps://www.addysolutions.com/signup to get an API key.
- Include addycomplete.min.css in your page, via the usual tags:
<linkrel="stylesheet"href="addy.min.css"/>
- Include addy.min.js at the bottom of the page, before closing the body tag:
<scriptsrc="addy.min.js?nzKey=YOUR-ADDY-KEY&country=nz&callback=initAddy"asyncdefer></script>
Replace YOUR-ADDY-KEY with your own Addy API Key. (for AU country, use 'auKey' instead 'nzKey' and 'country=au')
Define the fields and options that will be called by the initAddy callback function once the script has loaded.
functioninitAddy(){varaddyComplete=newAddyComplete(document.getElementById("address1"));addyComplete.fields={address1:document.getElementById("address1"),address2:document.getElementById("address2"),suburb:document.getElementById("suburb"),city:document.getElementById("city"),postcode:document.getElementById("postcode")}}
Live demo and documentation:https://www.addysolutions.com/services/address-validation-javascript
Visit the pricing page for more information and to find a plan that works for your business (https://www.addysolutions.com/pricing).
Official Addy site:https://www.addysolutions.com/
NZ Address Finder and Postcode API Documentation:https://www.addysolutions.com/documentation
All Documentation:https://www.addysolutions.com/documentation
Frequently Asked Questions:https://www.addysolutions.com/faqs
The Address Checker code is released under the MIT License.
The reqwest library included in the bundle is released under the MIT Licensehttps://github.com/LeaVerou/awesomplete.
The Neat Complete library included in the bundle is released under the GNU Affero General Public Licensehttps://github.com/AbleTech/neat-complete.
About
Address finder for websites to verify New Zealand addresses at the point of capture. Code samples are provided for fast and effective integration. Lightweight open source third party libraries are used for calling Addy’s free address finder API. Visithttps://www.addysolutions.com/ for documentation and free address API access.