> 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/api-specification.md).

# API Specification

Dive into the specifics of each API endpoint by checking out our complete documentation.

## Authentication

{% content-ref url="/pages/pNp2vsPEQmfbnHPzvwgn" %}
[Authentication](/loqate-harmony-api/api-specification/authentication.md)
{% endcontent-ref %}

## Address

Everything related to addresses:

{% content-ref url="/pages/5ylNPVUFqxzdVXGnD8kk" %}
[Address Validation & Lookup](/loqate-harmony-api/api-specification/address/address-validation-and-lookup.md)
{% endcontent-ref %}

{% content-ref url="/pages/NjSnzxkY97PKcUdk71DB" %}
[Address by Geocode](/loqate-harmony-api/api-specification/address/address-by-geocode.md)
{% endcontent-ref %}

{% content-ref url="/pages/SMyFPz9o7daempZRizy7" %}
[Address Cleanse v1](/loqate-harmony-api/api-specification/deprecated/address-cleanse.md)
{% endcontent-ref %}

{% content-ref url="/pages/UXWaaXwtlSoE2mgsMj2M" %}
[Address Parse](/loqate-harmony-api/api-specification/address/address-parse.md)
{% endcontent-ref %}

## Suburb/Postcode

Everything related to suburb/postcode

{% content-ref url="/pages/Mr9dtVymAa9CIMaNAJMX" %}
[Suburb Lookup](/loqate-harmony-api/api-specification/suburb-postcode-search.md)
{% endcontent-ref %}

## Business

Everything related to businesses:

{% content-ref url="/pages/VXBpoC6mGSdnonIKt82D" %}
[Business Validation and Lookup](/loqate-harmony-api/api-specification/business-validation.md)
{% endcontent-ref %}

## Email

Everything related to email:

{% content-ref url="/pages/jwJ0VitVUkvsQsVvs8Y6" %}
[Email Validation v1.1](/loqate-harmony-api/api-specification/deprecated/email-validation.md)
{% endcontent-ref %}

## Phone

Everything related to phone:

{% content-ref url="/pages/HhGDGUFD3213kXUmce24" %}
[Phone Validation](/loqate-harmony-api/api-specification/phone-validation.md)
{% endcontent-ref %}

## Matching

Everything related to matching:

{% content-ref url="/pages/emtsa2Jjqsev8YDKAOOH" %}
[Matching](/loqate-harmony-api/api-specification/matching.md)
{% endcontent-ref %}

## Suppression

Everything related to suppression:

{% content-ref url="/pages/fuGJNCGtZNekucjBFZfV" %}
[Moved Suppression](/loqate-harmony-api/api-specification/moved-suppression.md)
{% endcontent-ref %}

{% content-ref url="/pages/pvsLqeiP0qlPD0XMwhZI" %}
[Deceased Suppression](/loqate-harmony-api/api-specification/deceased-suppression.md)
{% endcontent-ref %}

## NZ Property Title

Everything related to Property Title:

{% content-ref url="/pages/eoloPzOULQhUhy5iIsMw" %}
[NZ Property Title](/loqate-harmony-api/api-specification/nz-property-title.md)
{% endcontent-ref %}


---

# 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.