> For the complete documentation index, see [llms.txt](https://docs.mastersoftgroup.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mastersoftgroup.com/loqate-harmony-api.md).

# Loqate Harmony API

- [API Specification](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification.md): Loqate Harmony API Specification
- [Authentication](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/authentication.md): Authentication is required when making calls to our RESTful webservices. The domain is required to match the host where the JavaScript code is used.
- [Address](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address.md): Our market leading address solutions standardises, validates and enriches your address information.
- [Address Validation & Lookup](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address/address-validation-and-lookup.md): Address lookup methods take partial or complete address information search against an address Source of Truth, returning validated and enriched address information.
- [Address by Geocode](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address/address-by-geocode.md): Reverse geocode or Address by Geocode methods take a pair of latitude and longitude coordinates as an input and return addresses information that match the search parameters.
- [Address Cleanse](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address/address-cleanse.md): Verifies, corrects and enriches address data to the highest level of precision and confidence, globally and at scale
- [Address Parse](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address/address-parse.md): Parse methods convert unstructured input data into structured component parts output.
- [Geocode Intl](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address/geocode-intl.md): Retrieves WGS84 geocode information for international address and locations.
- [Address Insights](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights.md): Address insights provide valuable data on enabling businesses to optimize operations and improve customer targeting by leveraging accurate and actionable geographic information
- [Australian Insights](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights/australian-insights.md)
- [SEIFA Australia](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights/australian-insights/seifa-australia.md): SEIFA is a suite of four summary measures that reflect the socio-economic wellbeing of geographic areas based on social and economic information from the 2021 Census of Population and Housing.
- [ASGS Australia Statistical Geography Standard](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights/australian-insights/asgs-australia-statistical-geography-standard.md): The Australian Statistical Geography Standard (ASGS) (ABS Australian Statistical Geography Standard (ASGS)) is the main geographical framework for the 2021 Census.
- [Residential / Commercial](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights/australian-insights/residential-commercial.md): Our address data package includes a powerful feature that distinguishes between residential and commercial addresses.
- [Deliverable address](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/address-insights/australian-insights/deliverable-address.md): Know an address is deliverable before ever shipping a package.
- [Suburb Lookup](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/suburb-postcode-search.md): Typeahead service for Searching for Suburbs and Postcodes
- [Business Validation and Lookup](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/business-validation.md): Business lookup methods take partial or complete business information to search against the business Source of Truth, returning validated and enriched business information.
- [Email Validation](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/email-validation.md): Performs a full mailbox validation on the supplied email address.
- [Phone Validation](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/phone-validation.md): Takes one or more mobile phone numbers as an input and performs validation, returning a list of the results. The maximum number of input phone numbers is 100 per call.
- [Matching](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/matching.md): Match methods match data sets and return the relevant matching results.
- [NZ Property Title](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/nz-property-title.md): Takes an single line address or semi-structure address or latitude, longitude as an input and performs property ownership validation, return validated result as passed or failed.
- [Moved Suppression](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/moved-suppression.md): Enriches address with know moved suppressions
- [Deceased Suppression](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deceased-suppression.md): Retrieves deceased suppression data using the supplied id (DPID). This API is only for AUPAF Source of Truth.
- [Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects.md): Detail data Objects (Data Models) of all our services.
- [Address Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/address-objects.md): We have three different types of objects suited to primary business regions being Australia, New Zealand and International (rest of world).
- [Address Type Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/address-objects-1.md): Address type information applicable for ANZ only
- [Suburb Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/suburb-objects.md)
- [Parse Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/parse-objects.md)
- [Email Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/email-objects.md)
- [Phone Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/phone-objects.md)
- [Property Title Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/property-title-objects.md)
- [Match Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/match-objects.md)
- [Business Objects](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/business-objects.md)
- [Deprecated API services](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated.md): Depreciated or planned end of life for existing services.
- [Email Validation v1.1](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/email-validation.md): Performs a full mailbox validation on the supplied email address.
- [Address v1](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/address-v1.md)
- [Address Cleanse v1](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/address-cleanse.md): Cleanse methods validate the single line input address based on the required source of truth.
- [Address International](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/address-v1-1.md)
- [Address Combined](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/address-v1-2.md)
- [Address Types](https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/deprecated/address-v1-3.md)
- [Guides](https://docs.mastersoftgroup.com/loqate-harmony-api/guides.md): Some topics require more guidance and understanding. Here we explain the detail on tuning your implementation for your use cases.
- [Best Practices](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/best-practices.md)
- [Address Field Mappings](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/best-practices/address-field-mappings.md): Our recommended commonly used field mappings.
- [Finding an Address](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/best-practices/finding-an-address.md): This guide details the best methods for finding an Address using GBG Loqate Australia & New Zealand services
- [User Derived Address](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/user-derived-address.md): Using user input to infer subdwelling address component exists to assist the user journey with validation address information.
- [Expanded sub-premise reach](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/expanded-sub-premise-reach.md): Expand your reach be enabling sub-premise reach feature to increases successful address finds to sub-premises not within our authoritative data.
- [Parcel Locker Plus](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/parcel-locker-plus.md): Deliver your products to over 4,700 collections point including  Australia Posts Parcel Locker, Post Office and retail partner network.
- [Migrating to Address V2](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/migrating-to-address-v2.md): Step by step guide to migrating to Address V2.
- [Sign up/ Login](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/sign-up-login.md): How to sign up to Loqate Harmony API service.
- [Support](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/support.md)
- [Console](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console.md)
- [Getting your API keys](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/getting-your-api-keys.md)
- [Getting Started](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/getting-started.md)
- [Add a Service](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/add-a-service.md)
- [Dashboard](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/dashboard.md): Dashboard that enables the customer to get a graphical representation of their API call usage analytics both on a daily and monthly basis. We also show pie charts that depict customers active plans.
- [Subscriptions](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions.md)
- [Features](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/features.md)
- [Users](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/users.md)
- [Subscribed Plans](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/subscribed-plans.md)
- [Allowlisting domains](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/allowlisting-domains.md)
- [Blocklist - Email Validation](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/blocklist-email-validation.md)
- [Reports](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/reports.md)
- [Invoices](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/invoices.md)
- [Paying Invoices](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/invoices/paying-invoices.md)
- [API Latency](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/api-latency.md): Our service API Latency
- [Demos](https://docs.mastersoftgroup.com/loqate-harmony-api/demos.md)
- [How to use our demos](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/how-to-use-our-demos.md)
- [Address Validation Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/address-validation-demo.md)
- [Address by Geocode (Reverse Geocode) Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/address-by-geocode-reverse-geocode-demo.md)
- [Address Cleanse Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/address-cleanse-demo.md)
- [Address Parse Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/address-parse-demo.md)
- [Business Validation Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/business-validation-demo.md)
- [Email Validation Demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/email-validation-demo.md)
- [Phone Validation demo](https://docs.mastersoftgroup.com/loqate-harmony-api/demos/phone-validation-demo.md)
- [Integrations](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations.md)
- [Client Libraries](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/client-libraries.md): Fast integrations using our pre-built client side libraries
- [Javascript Library v2.7.0](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/client-libraries/javascript-library-v2.7.0.md): Important Note: As of June 2026, we have upgraded the JavaScript library used in Loqate Harmony solutions to the client side to address certain security fixes.
- [Adobe Commerce (Magento 2) Plugin](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/adobe-commerce-magento-2-plugin.md): Speed up your Adobe Commerce (Magento) checkout with real-time address verification.
- [Magento2 User Guide](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/adobe-commerce-magento-2-plugin/magento2-user-guide.md): Loqate AU & NZ Address Autocomplete extension module for Magento2
- [Woocommerce Plugin](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/woocommerce-plugin.md): Optimise your WooCommerce checkout process with real-time verification, single line lookup of address & businesses, validate email & phone numbers in checkout. Download for free.
- [Woocommerce Install Guide v2.0.0](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/woocommerce-plugin/woocommerce-user-guide.md): How to install Loqate AU NZ Woocommerce Plugin
- [Woocommerce Settings guide v2.0.0](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/woocommerce-plugin/woocommerce-settings-guide-v2.0.0.md): How to configure the settings Loqate AU NZ Woocommerce Plugin. You have full control over what is enabled with full access to API settings.
- [Shopify Plus App](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/shopify-plus.md): Checkout UI for Shopify Plus checkout with real-time address verification.
- [Gravity Forms](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/gravity-forms.md): Gravity Forms is a powerful form-building plugin for WordPress that allows you to create complex forms with ease. Utilise Gravity Forms to enhance your workflows with real-time address verification.
- [Voxco Survey Software](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/voxco.md): Voxco is a great survey software to run any type of survey, including employee engagement, customer satisfaction, or transition feedback.
- [Salesforce CRM](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/salesforce-crm.md): Loqate helps eliminate friction and ensures only complete and accurate address data comes from your Salesforce forms.
- [Dynamics 365 CRM](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/dynamics-365-crm.md): A faster, easier way to enter and verify addresses in Microsoft Dynamics 365.
- [Batch App - Lightweight](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/batch-app-lightweight.md): A faster, easier way to enter and verify addresses in small batches.
- [Deprecated Integrations](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/deprecated-integrations.md)
- [Harmony RightAddress c# example](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/deprecated-integrations/harmony-rightaddress-c-example.md)
- [Harmony RightAddress cURL example](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/deprecated-integrations/harmony-rightaddress-curl-example.md)
- [Deprecated JS Library v2.0.1](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/deprecated-integrations/deprecated-js-library-v2.0.1.md)
- [Deprecated JQuery Library v1.8.1](https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/deprecated-integrations/deprecated-jquery-library-v1.8.1.md)
- [Coverage](https://docs.mastersoftgroup.com/loqate-harmony-api/coverage.md): Regions of coverage used by our services.
- [Address Exchange (Beta)](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta.md)
- [ADX Console](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-console.md): Address Exchange for Console Service Users
- [Searching Addresses in console](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-console/searching-addresses-in-console.md): Search and understand the history of address in Address Exchange
- [Create Address in console](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-console/create-address-in-console.md): Console creating address in address exchange
- [Create Actions in console](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-console/create-actions-in-console.md): Create events about about your interactions with a created address
- [ADX API Specification](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification.md)
- [Create Address](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/create-address.md): Creates address in Address Exchange using structured data
- [Get Address](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/get-address.md): Get Address from Address Exchange
- [Create Address Event](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/create-address-event.md): Create Address Events to Address in Address Exchange
- [Edit Address Event](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/edit-address-event.md): Edit Address Events in Address Exchange
- [Create/Edit Address Attributes](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/create-edit-address-attributes.md)
- [Create/Edit Address Geopoint](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/create-edit-address-geopoint.md): Add or Edit Geopoint of Address in Address Exchange
- [Get Source Events](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/adx-api-specification/get-source-events.md): Get a list of events sources.
- [Reserved Attributes](https://docs.mastersoftgroup.com/loqate-harmony-api/address-exchange-beta/reserved-attributes.md): Reserved Attributes are attribute names that are reserved for specific functions.
- [Release Notes](https://docs.mastersoftgroup.com/loqate-harmony-api/release-notes.md): This page serves as a comprehensive repository of Release Notes for each release of our Harmony API Product since 2026 March.
- [Release 2026 March](https://docs.mastersoftgroup.com/loqate-harmony-api/release-notes/release-2026-march.md): Planned on 19 March 2026 for version 2.18


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mastersoftgroup.com/loqate-harmony-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.