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

# API access

### Obtaining API keys

* **Navigate to the API keys section**: Log into your Identomat dashboard and select **API keys** from the menu**,** nested under **Settings** .
* **Generate key**: In the API section, click the **Generate key** button. 
* **Whitelist IPs (optional):** You can restrict a key to a set of specific IP addresses, so that only requests from those IPs are accepted — requests from any other IP will be rejected. If no IPs are added, the key will accept requests from any IP. Whitelisted IPs aren't locked in at generation — you can add or remove them at any time from the key's settings.
* :exclamation: **Store securely**: Copy the generated API key and securely store it. For security purposes, the key will only be displayed once. If lost, you’ll need to generate a new one.

> 💡 **HMAC authorization**: For enhanced security, you can implement HMAC authorization using your secret key as the encryption key. This is optional but recommended for production environments.

### Procedure

The integration procedure consists of the following steps:

1. **Acquiring a `session_token`.**
2. **Redirecting the user's browser to widget.identomat.com.**
3. **Checking for a result.**

To acquire a `session_token`, the company server needs to call the **/begin** endpoint and provide the following arguments: `company_key`, `flags` and `steps`. The steps array contains the configuration for individual steps in the identification process, each of which can have its own set of flags specific to that step. 

**The endpoint used to create a session\_token:**

```
https://widget.identomat.com/begin/
```

For more details, see:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Developer guide</strong></mark></td><td>Step-by-step instructions and best practices for integrating and customizing our identity verification solutions.</td><td></td><td><a href="/pages/0b9rYxbzZRr3nXjJ1NQ2">/pages/0b9rYxbzZRr3nXjJ1NQ2</a></td></tr><tr><td><mark style="color:blue;"><strong>API Reference</strong></mark></td><td>Comprehensive details on endpoints, parameters, and response formats for seamless API integration.</td><td></td><td><a href="/pages/rA1jtXPZQc2eZi7l7nLP">/pages/rA1jtXPZQc2eZi7l7nLP</a></td></tr></tbody></table>


---

# 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.identomat.com/get-started/api-access.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.