# AddressZen > Add US and international address search and verification in moments - [AddressZen](/index.md) ## docs - [Changelog](/docs/changelog.md): Stay informed about the latest updates and improvements to our address validation services with our changelog. View release notes and see what's new. - [Glossary](/docs/glossary.md): --- - [Open API Specification](/docs/libraries/open-api.md): OpenAPI - [CSS Classes](/docs/styling-with-css.md): idpc_autocomplete - [Styling With javascript](/docs/styling-with-javascript.md): mainStyle - [Tagging](/docs/tags.md): Any request which affects your Key balance may be decorated with metadata called tags. This data is stored along with your lookup history and can be queried via the API. We call the ability to label your requests "tagging". - [Term](/docs/terms/term.md): Term explanation ### Address Lookup Add Address Verification to your address forms in moments with our Address Lookup JavaScript package. - [Address Lookup](/docs/address-lookup.md): Add Address Verification to your address forms in moments with our Address Lookup JavaScript package. - [Additional Configuration](/docs/address-lookup/additional-configuration.md): Separate Input Field - [Retrieve Additional Data](/docs/address-lookup/additional-data.md): You may insert more address attributes into your form by expanding - [Behaviour](/docs/address-lookup/behaviours.md): This guide outlines technical details about how Address Lookup behaves and interacts with the DOM. - [Bias By Geolocation](/docs/address-lookup/bias-by-geolocation.md): Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is 50000. - [Bias By IP](/docs/address-lookup/bias-by-ip.md): Biases search based on approximate geolocation of an IP address. Set bias_ip to true within queryOptions to enable. - [Bias By Postcode Outward](/docs/address-lookup/bias-by-postcode.md): Display address results that closely matches the chosen postcode outward value. - [Callbacks](/docs/address-lookup/callbacks.md): Address Lookup also provides callbacks which let you hook the following events: - [Configure](/docs/address-lookup/configure.md): Address Lookup exports a method to apply address verification to a form. requires the following configuration at minimum. - [CSS Classes](/docs/address-lookup/css-classes.md): The Address Lookup can be styled CSS classes. - [Setting the default country](/docs/address-lookup/default-country.md): Disable the country detection on Address Finder and set the default country. - [Default Styling](/docs/address-lookup/default-styling.md): Address Lookup's default styling works by injecting a style tag into the document head. - [Detach Address Lookup](/docs/address-lookup/detach.md): After instatiation, you can detach Address Lookup with . - [Exclude Islands](/docs/address-lookup/exclude-islands.md): Removes US addresses from these islands: - [Exclude Military Addresses](/docs/address-lookup/exclude-military.md): Remove military addresses from the list of suggestions. - [Exclude PO Box](/docs/address-lookup/exclude-po-box.md): Remove addresses that have a PO Box from the list of suggestions. - [Filter By Country](/docs/address-lookup/filter-by-country.md): Display address results that matches the chosen country (England, Wales, Scotland, Northern Ireland, Jersey, Guernsey and Isle of Man )) using queryOptions. - [Filter By Geospatial Box](/docs/address-lookup/filter-by-geospatial-box.md): Restrict search to a geospatial box determined by the "top-left" and "bottom-right" gelocations. - [Filter By Locality](/docs/address-lookup/filter-by-locality.md): Display address results that matches the chosen locality, like a post town (post_town) using queryOptions. - [Filter By Postcode Outward](/docs/address-lookup/filter-by-postcode.md): Display address results that matches the chosen postcode outward value. - [Hide Address Fields](/docs/address-lookup/hide.md): Hide - [How it Works](/docs/address-lookup/how-it-works.md): Address Lookup can be attached to any form with pre-existing address inputs. - [Checking the usability of your key](/docs/address-lookup/key-usability.md): Your key may not be available at some times. For instance: - [Messages](/docs/address-lookup/messages.md): Address Lookup uses a small default set of messages to communicate specific events to the user. All of Address Lookup's default messages can be overridden. They are outlined below: - [Attach Multiple Instances](/docs/address-lookup/multiple.md): Address Lookup can be invoked multiple times to attach multiple instances to your forms. - [Package Manager (npm)](/docs/address-lookup/npm.md): Address Lookup is also available without transpilation or minification on npm as @addresszen/address-lookup. - [Vertically Shift Address Lookup](/docs/address-lookup/nudge-address-finder.md): From time to time, you may want to tweak the default style of Address Lookup to better match your applications design system. - [Omit Company Name](/docs/address-lookup/omit-organisation.md): In many countries including the UK, the organization name will take presidence as the first line of an address if it is present. - [Prevent Autofill](/docs/address-lookup/prevent-autofill.md): Sets the autocomplete= attribute of the input element. Setting this attribute aims to prevent some browsers (particularly Chrome) from providing a clashing autofill overlay. - [Add to your React Application](/docs/address-lookup/react.md): This example deploys Address Lookup with React - [Restrict search to chosen countries](/docs/address-lookup/restrict-country.md): Narrow the countries you wish to support - [Restrict To Mainland US](/docs/address-lookup/restrict-to-mainland-us.md): Narrow the addresses to return US Mainland addresses only. - [Restrict To States](/docs/address-lookup/restrict-to-states.md): Narrow the states you wish to support - [Drop-In Script](/docs/address-lookup/script.md): Address Lookup is shipped in a polyfilled, typed and minified package called address-lookup. - [Separate Input from Address](/docs/address-lookup/separate-input.md): Specify an to apply the Address Lookup to a field other than the first line of the address. - [Merge Address into a Single Field](/docs/address-lookup/single-field.md): Instead of writing each address attributes to individual fields, you may exercise fine control about how address data is presented using the callback. - [Style Adjustments](/docs/address-lookup/style-tweaks.md): It's possible that the default styling may require a small tweak to allow it to better match your design and site aesthetic. Rather than adding CSS assets, we recommend applying a style attribute as a setup configuration option. The configurations below apply a style attributely directly to a specific element of the Address Lookup. - [Validate Before Submitting](/docs/address-lookup/validate-before-submitting.md): Overview ### Address Verification - [Address Verification](/docs/address-verification/getting-started.md): Clean, standardize, and validate US addresses using USPS CASS-certified data. ### API Reference - [API](/docs/api.md) - [Cleanse Address](/docs/api/address-cleanse.md): The address cleanse API attempts to return the closest matching address for any given address inputs. We also return a number of Match Level indicators that describe the degree to which the suggested address matches the input address. The more impaired the input address, the harder it is to cleanse. - [Address Search](/docs/api/address-search.md): Address Search - [Verify Address](/docs/api/address-verify.md): The address verify API validates, corrects, and standardizes individual addresses based on USPS's Coding Accuracy Support System (CASS). - [Extract Addresses](/docs/api/addresses.md): Extract a list of complete addresses that match the query ordered by relevance score. This query accepts an optional limit and page query (defaults to 10 and 0 respectively). - [API Reference](/docs/api/api-reference.md): ## Getting Started - [Create](/docs/api/create-config.md): Create a configuration - [Create](/docs/api/create-licensee.md): Create a licensee for the specified API Key. - [Delete](/docs/api/delete-config.md): Permanently deletes a configuration object. - [Cancel](/docs/api/delete-licensee.md): Cancels a licensee key. This renders a licensee unusable. This action can be reversed if you get in contact with us. - [Email Validation](/docs/api/email-validation.md): Query for and validate email addresses. - [Find Address](/docs/api/find-address.md): The Address Autocomplete API delivers address suggestions in order of relevance based on a provided query. It aids real-time address autofill implementations. - [Find Place](/docs/api/find-place.md): Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id. - [Availability](/docs/api/key-availability.md): Returns public information on your API Key. - [Details](/docs/api/key-details.md): Returns private data on the key including remaining lookups, available datasets and usage limits. - [Logs (CSV)](/docs/api/key-logs.md): Reports lookup information on a key for paid lookups. - [Usage Stats](/docs/api/key-usage.md): Reports the number of lookups consumed on a key for a range of days. - [Keys](/docs/api/keys.md): Keys - [Licensees](/docs/api/licensees.md): Licensees - [List](/docs/api/list-configs.md): Lists configurations associated with a key - [List](/docs/api/list-licensees.md): Returns a list of licensees for a key. - [Phone Number Validation](/docs/api/phone-number-validation.md): Query for and validate phone numbers. - [Place Search](/docs/api/place-search.md): Place Search - [Lookup Postcode](/docs/api/postcodes.md): Returns the complete list of addresses for a postcode. Postcode searches are space and case insensitive. - [Resolve Address](/docs/api/resolve-address.md): Resolves an address autocompletion by its address ID. - [Resolve Place](/docs/api/resolve-place.md): Resolves a place autocompletion by its place ID. - [Retrieve Address](/docs/api/retrieve-address.md): Resolves an address autocompletion by its address ID. - [Retrieve](/docs/api/retrieve-config.md): Retrieve configuration object by name - [Retrieve](/docs/api/retrieve-licensee.md): Returns licensee information as identified by the licensee key. - [Retrieve by UDPRN](/docs/api/udprn.md): Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN). - [UK](/docs/api/uk.md): UK - [Retrieve by UMPRN](/docs/api/umprn.md): Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). - [Update](/docs/api/update-config.md): Updates configuration object - [Update Details](/docs/api/update-key-details.md): Update API Key Details - [Update](/docs/api/update-licensee.md): Update Licensee ### Data Our address search and verification APIs can return addressing data in different formats corresponding with different national conventions and datasets. These formats are documented here: - [Data](/docs/data.md): Our address search and verification APIs can return addressing data in different formats corresponding with different national conventions and datasets. These formats are documented here: - [IE Address (ECAD)](/docs/data/ecad.md): ECAF file including additional data for each address. - [IE Address (ECAF)](/docs/data/ecaf.md): Essential Elements - [Geonames](/docs/data/geonames.md): Geoname ID - [Geocoded National Address File](/docs/data/gnaf.md): Essential Elements - [HERE Global Address](/docs/data/here.md): HERE provides comprehensive global address data with standardised formats across 240+ countries and territories. - [Kadaster](/docs/data/kadaster.md): Essential Elements - [Kartverket](/docs/data/kartverket.md): Essential Elements - [Multiple Residence](/docs/data/mr.md): For more information on the Multiple Residence dataset, please refer to our comprehensive guide on this topic: Read More. - [Not Yet Built](/docs/data/nyb.md): The Not Yet Built address format is identical to the Postcode Address File format. - [Standard UK Address](/docs/data/paf.md): Our APIs return all data contained in Royal Mail's Postcode Address File. - [UK Alias Addresses](/docs/data/paf-aliases.md): The Alias address format is identical to the Postcode Address File format. - [Supported Territories](/docs/data/paf-supported-territories.md): The PAF dataset covers the UK only. This includes: - [United States Postal Service Address](/docs/data/usps.md): Essential Elements - [Welsh Address](/docs/data/welsh-paf.md): The Welsh Postcode Address File format is identical to the Postcode Address File format except locality information such as post town locality dependent are presented in Welsh. ### Guides Learn more about address verification, integrating our products and account management. - [Guides](/docs/guides.md): Learn more about address verification, integrating our products and account management. - [Allowed URLs](/docs/guides/allowed-urls.md): Each Key can be restricted against a number of URLs. Individual Licensee Keys can also have allowed URLs assigned to them. - [API Key](/docs/guides/api-key.md): What is an API Key? - [API Key Security](/docs/guides/api-key-secure.md): In order to mitigate the risk of misuse, usage of your API Key can be controlled in the following ways: - [API Key Settings](/docs/guides/api-key-settings.md): You can limit your API Key usage via the Security panel on your dashboard. This is important when you want to control how many lookups you spend per day. - [Automated Top-Ups](/docs/guides/automated-topups.md): Enabling Automated Top-Ups - [Data Processing](/docs/guides/data.md): Outlined in this document is a concise overview of how modern data protection law (namely, GDPR) relates specifically to us as your data processor (or subprocessor). - [Data Processing](/docs/guides/data-processing.md): Outlined in this document is a concise overview of how modern data protection law (namely, GDPR) relates specifically to us as your data processor (or subprocessor). - [Places API](/docs/guides/places.md): Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id. - [Purchasing Lookups](/docs/guides/purchasing-lookups.md): A lookup balance is our form of credit which permits one valid address search. - [Sublicensing](/docs/guides/sublicensing.md): Sublicensing Keys allow you to license multiple organisations or individuals under the same key. All managed, controlled and billed to you under the same account. - [Tag and Track Usage](/docs/guides/tag-and-track.md): You can segregate and track usage statistics on your API Key by using our tagging feature. This allows you tag tag individual API requests and have the tag returned in your usage logs for later sorting and analysis. - [API Testing](/docs/guides/testing.md): We recommended using hardcoded test requests previously, we now recommend testing genuine address requests with a test balance or dedicated test key. ### How to Switch Switching from Google's Address Validation and Place Autocomplete to AddressZen offers distinct advantages, particularly for applications targeting a U.S. audience: - [How to Switch](/docs/how-to-switch.md): Switching from Google's Address Validation and Place Autocomplete to AddressZen offers distinct advantages, particularly for applications targeting a U.S. audience: - [Additional Configuration](/docs/how-to-switch/additional-configuration.md): Expanding on the additional configuration options for AddressZen's Address Lookup service can help you fine-tune how address data is gathered and presented within your application, enhancing usability and the overall user experience. Here's a detailed explanation of each configuration option mentioned: - [Search Boundaries](/docs/how-to-switch/search-boundaries.md): AddressZen offers a suite of advanced features to tailor the address lookup functionality to your specific needs. This guide outlines how to implement Bias By IP, Filter By Country, Exclude Islands, Exclude Military Addresses, and Exclude PO Boxes, enabling a more customized and relevant user experience. ### Integrations Quickly add address validation to eCommerce platforms, CRMs, form builders and more with one of our native extensions or integration guides. - [Integrations](/docs/integrations.md): Quickly add address validation to eCommerce platforms, CRMs, form builders and more with one of our native extensions or integration guides. - [BigCommerce Address Verification Documentation](/docs/integrations/bigcommerce.md): Features - [Browser Extension Integration](/docs/integrations/browser-extension.md): Integrate Address Validation to Chrome and Firefox Browsers. - [Contact Form 7 Address Verification](/docs/integrations/contact-form-7.md): Integrate Address Validation to Your WordPress Contact Form 7 Pages. - [Divi Address Verification](/docs/integrations/divi.md): Integrate Address Validation with the WordPress Divi Page Builder. - [Microsoft Dynamics 365 Integration | Documentation](/docs/integrations/dynamics-365.md): Integrate Address Validation on Dynamics 365 - [Elementor](/docs/integrations/elementor.md): Add address validation to your Wordpress Elementor pages. Follow the address lookup guide to get started. - [FormAssembly Address Verification](/docs/integrations/formassembly.md): Demo - [Formidable Forms Address Verification Integration](/docs/integrations/formidable.md): Demo - [Forminator](/docs/integrations/forminator.md): Add address lookup to your Wordpress Forminator pages. Follow the address lookup guide to get started. Live developer support. - [Formstack Integration](/docs/integrations/formstack.md): Add address verification to your Formstack Form builder with AddressZen Address Lookup integration. Simply insert javascript into the form builder. - [Gravity Forms Address Verification Integration](/docs/integrations/gravity-forms.md): Demo - [Gutenberg Forms Address Verification Integration](/docs/integrations/gutenberg.md): Integrate Address Validation to Your WordPress Gutenberg Forms Pages. - [Hubspot Address Verification Integration | Documentation](/docs/integrations/hubspot.md): Add address validation to your HubSpot CRM with our Browser Extension. - [JetFormbuilder Address Verification](/docs/integrations/jetformbuilder.md): Demo - [Installing Address Verification for Magento](/docs/integrations/magento.md): Magento extension for US address search and verification. Follow our setup guide to get started. Quick and easy implementation. Live developer support available. - [Ninja Forms Address Verification](/docs/integrations/ninja-forms.md): Demo - [Odoo Address Verification Integration | Documentation](/docs/integrations/odoo.md): Enable Address Lookup to Odoo CRM with our Chrome and Firefox browser extensions - [OpenCart Address Verification Integration](/docs/integrations/opencart.md): OpenCart Module for UK Address Search and Validation - [Really Simple Systems](/docs/integrations/really-simple-systems.md): Integrate Address Validation on your Really Simple Systems CRM - [Sage Business Cloud Accounting Integration](/docs/integrations/sage.md): Integrate Address Validation to Your Sage Application - [Salesforce Integration](/docs/integrations/salesforce.md): Integrate address validation to your Salesforce CRM address forms with our Browser Extension. - [ShopWired Address Verification](/docs/integrations/shopwired.md): Shopwired Integration for UK Address Search and Validation - [Unbounce Address Verification](/docs/integrations/unbounce.md): Integrate Address Validation to Your Unbounce Form - [Wix Integration](/docs/integrations/wix.md): Integrate Address Verification with the Wix Editor. - [WooCommerce Address Verification](/docs/integrations/woocommerce.md): WooCommerce extension for US address search and validation - [Zapier Address Verification | Documentation](/docs/integrations/zapier.md): Zap Creation - [Zoho CRM](/docs/integrations/zoho-crm.md): Add Address Lookup to Zoho CRM with our Browser Extension. ## Optional - [OpenAPI Specification (JSON)](https://openapi.addresszen.com/openapi.json): Machine-readable API specification in JSON format - [OpenAPI Specification (YAML)](https://openapi.addresszen.com/openapi.yaml): Machine-readable API specification in YAML format