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

# Authentication

Authentication is required when making calls to our RESTful webservices. The domain is required to match the host where the JavaScript code is used.

## API keys

We use basic authentication over secure http (HTTPS). Basic authentication is a method for an HTTP user agent (e.g. a web browser) to provide a user name and password when making a request. In our case, by using basic HTTP authentication, a request contains a header field in the form of `Authorization: Basic <API-Key>` where `<API-Key>` is the base-64 encoded string of `<API-User>:<API-Credential>`.

## Allowlist domains

Customer who has implemented our service as front end, i.e. typically from a website using JavaScript will require API users with allowlisted domains. Allowlisting of the domains ensures that access to our service is not compromised and allows only certain domains to connect to our service.

Typically customer who has implemented our service in backend using Java, C#,PHP or Curl etc. will not require any referrer domains to be allowlisted as the back end implementation is already secured enough as the call happens from server side.

However some customers may require some additional layer of security to ensure their credentials are not compromised by other internal teams or external third party etc. In such cases domains can be allowlisted so that only the JavaScript code from those domains can make successful calls to our APIs.

API users and domain allowlisting can be done by the customer once they sign up for free Trial using [Allowlisting domains](https://docs.mastersoftgroup.com/loqate-harmony-api/guides/console/subscriptions/allowlisting-domains.md)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
