> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Аутентификация API: безопасные запросы к KYC API

> Аутентифицируйте запросы к API Didit с помощью ключа в заголовке x-api-key. Ошибочный ключ возвращает 401, отсутствующий — 403.



Промпт для аутентификации в API
        Скопировать промпт в буфер обмена



      
      

\<pre>

\````# Goal — authenticate against Didit's REST API

Two hosts, two auth schemes. Never mix them up.

\## Host map

\| Host | Surface | Auth header |
\|---|---|---|
\| `https://verification.didit.me` | Verification API — sessions, workflows, entities, transactions, standalone APIs, lists, webhooks, billing (every `/v3/...` route) | `x-api-key: <DIDIT_API_KEY>` |
\| `https://apx.didit.me` | Account / organization / application management (`/auth/v2/programmatic/...`, `/auth/v2/organizations/...`) | `Authorization: Bearer <JWT access_token>` |

The verification API does **not** use OAuth Bearer tokens. It uses a long-lived API key on the `x-api-key` header. Treat the key as a server-side secret — never ship it to a browser or mobile bundle.

\## How to obtain the api_key (no console UI needed)

\<Warning>
Substitute `you@yourdomain.com` below with a real inbox. The register endpoint sends the verification code synchronously, so reserved test domains (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) get refused by mail delivery and the call returns a `500`.
\</Warning>

\```bash
\# 1) Register — emails a 6-char code (15 min TTL).
\#    Password rules: ≥8 chars, 1 uppercase, 1 lowercase, 1 digit, 1 special.
curl -X POST https://apx.didit.me/auth/v2/programmatic/register/ \
-H "Content-Type: application/json" \
-d '{"email": "you@yourdomain.com", "password": "StrongP@ss1"}'

\# 2) Verify email — returns api_key inline.
curl -X POST https://apx.didit.me/auth/v2/programmatic/verify-email/ \
-H "Content-Type: application/json" \
-d '{"email": "you@yourdomain.com", "code": "A3K9F2"}'
\# 200 -> { access_token, refresh_token, organization, application: { api_key, client_id, uuid } }
\```

Persist `response.application.api_key` as the env var `DIDIT_API_KEY`.
New keys start with `sk_live_` (live application) or `sk_test_` (sandbox application), followed by 43 URL-safe characters.
Keys created before this format have no prefix and keep working, so never validate a key by its prefix.

\## Recover the key (lost it)

\```bash
\# Log back in to get a fresh JWT
TOK=$(curl -s -X POST https://apx.didit.me/auth/v2/programmatic/login/ \
-H "Content-Type: application/json" \
-d '{"email":"you@yourdomain.com","password":"StrongP@ss1"}' | jq -r .access_token)

\# Find your org and app
curl https://apx.didit.me/auth/v2/organizations/me/ -H "Authorization: Bearer $TOK"
curl https://apx.didit.me/auth/v2/organizations/me/$ORG_ID/applications/$APP_ID/ \
-H "Authorization: Bearer $TOK"
\# Response.api_key is your key.
\```

\## Calling the verification API

\```bash
curl -X POST https://verification.didit.me/v3/session/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"workflow_id":"<WORKFLOW_ID>","vendor_data":"user-42","callback":"https://myapp.com/return"}'
\```

\## Failure modes

\| Status | Meaning | Fix |
\|---|---|---|
\| `401` on verification.didit.me | `x-api-key` header wrong, malformed, revoked or expired | Re-fetch via the recover-key flow above, or use a key that has not expired |
\| `403` on verification.didit.me | No `x-api-key` header, a scoped key without access to this resource or action, or a key called from an address outside its IP list | Use a key with that access (Developers -> API keys in the console) |
\| `403` with `"code": "application_deleted"` on verification.didit.me | The key's application was deleted. You get this for a few minutes after the deletion; after that the key is refused like any invalid key | Do not retry: the application and its keys no longer exist. Use a key of an application that exists |
\| `404` on a session route | The session is outside the scoped key's workflows or statuses | Use a key whose limits include that session |
\| `403` on apx.didit.me | JWT `Authorization` header missing or expired | Call `POST /auth/v2/programmatic/login/` again |
\| `429` | Rate limit; response includes a `wait` field (seconds) | Back off, then retry |

\## Sources of truth
\- /openapi-auth.json — every account / org / app endpoint
\- /openapi-25.json — every verification endpoint
\- /integration/integration-prompt — end-to-end integration recipe````

\</pre>



      
      

Вставьте в

## Как найти API-ключВ Didit API-ключи привязаны к конкретному **Приложению** в вашем аккаунте. Приложение представляет собой рабочее пространство, где вы можете настраивать сценарии и управлять верификациями для определённого проекта или среды.Каждое Приложение при создании получает основной API-ключ с полным доступом. Вы можете добавить к нему дополнительные ключи, каждый из которых будет иметь только тот доступ, который необходим сервису или партнёру. Чтобы найти свои ключи:**1. Войдите в Business Console**Перейдите в [**Didit Business Console**](https://business.didit.me) и войдите в систему.**2. Выберите ваше Приложение**Выберите **Приложение**, с которым хотите работать, в выпадающем меню вверху.**3. Откройте API-ключи**Перейдите в **Developers -> API keys** на панели навигации слева.**4. Скопируйте или создайте ключ**Ключ **Основной** представляет собой собственный секрет Приложения. Создайте новый ключ, чтобы предоставить сервису или партнёру отдельный секрет с необходимым уровнем доступа.> [!WARNING]
>
> **Ваш API-ключ является секретом: относитесь к нему как к паролю.**
>
> Основной ключ предоставляет полный доступ к API от имени вашего Приложения. Никогда не раскрывайте его во фронтенд-коде, публичных репозиториях или клиентских бандлах. Всегда храните его только на стороне сервера.### Формат API-ключаНовые API-ключи начинаются с `sk_live_` для продакшн-приложения или `sk_test_` для песочницы, за которыми следуют 43 URL-безопасных символа (буквы, цифры, `-` и `_`).
Ключи, созданные до введения этого формата, не имеют префикса и продолжают работать без изменений.
Отправляйте ключ целиком, включая префикс, в заголовке `x-api-key`, и не отклоняйте ключ из-за отсутствия префикса.## Как найти ID организацииВаш **ID организации** — это UUID, который идентифицирует вашу организацию. Вы используете его в путях API на уровне организации, таких как `/auth/v2/organizations/me/{org_id}/applications/`. Вы можете скопировать его напрямую из Business Console без необходимости вызова API:**1. Откройте настройки организации**В [**Didit Business Console**](https://business.didit.me) перейдите в **Настройки организации**.**2. Скопируйте ID организации**В поле **ID организации** отображается UUID вашей организации рядом с её названием, а также кнопка копирования в буфер обмена.***## Выполнение аутентифицированных запросовЧтобы аутентифицировать запрос к API, включите ваш секретный API-ключ в HTTP-заголовок `x-api-key`.Вот пример аутентифицированного запроса к endpoint `Create Session`:```shell cURL theme={null}
curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'
```***## Обработка ошибокЕсли ваш API-ключ неверный, некорректно сформирован или отозван, API возвращает `401 Unauthorized`:```json theme={null}
{
  "detail": "Authentication credentials were not provided or are invalid."
}
```Если срок действия ключа истёк, также возвращается `401` с `"detail": "This API key has expired."`.
Запрос без ключа возвращает `403` с `"detail": "You do not have permission to perform this action."`.| Код статуса | Значение |
| - | - |
| **401** | API-ключ неверный, некорректно сформирован, отозван или срок его действия истёк |
| **403** | API-ключ не был передан, у ключа нет доступа к запрашиваемому ресурсу или действию, либо запрос поступил с адреса вне списка IP-адресов ключа |
| **403** с `"code": "application_deleted"` | Ключ принадлежит приложению, которое было удалено. API возвращает этот ответ в течение нескольких минут после удаления, а затем отклоняет ключ как недействительный. Не повторяйте попытку: приложение и его ключи больше не существуют. |
| **404** | Для маршрутов сессий: сессия не соответствует сценариям или статусам, разрешённым для ключа |На странице [Ошибки API](https://docs.didit.me/ru/integration/api-errors.md) перечислены все статусы, тела ответов и коды.***## API-ключи с ограниченным доступомПредоставляйте каждому сервису или партнёру отдельный ключ вместо использования общего основного ключа.
Каждый ключ имеет собственный уровень доступа для каждого ресурса: нет доступа, чтение или запись (сессии, решения, медиафайлы, физические лица, компании, транзакции, сценарии, webhook, настройки приложения, аналитика), а также опциональные ограничения по определённым сценариям, только одобренным сессиям, списку IP-адресов и сроку действия.
Вы можете ротировать ключ с 24-часовым периодом параллельной работы и мгновенно его отзывать.Ключи, созданные до появления ограниченного доступа, сохраняют полный доступ.В разделе [API-ключи](https://docs.didit.me/ru/console/api-keys.md) описаны готовые шаблоны прав, ресурсы, которые они охватывают, и то, как API отвечает на запросы с ключом с ограниченным доступом.> [!TIP]
>
> Если вы получаете ошибку `401`, убедитесь, что используете правильный API-ключ для нужного Приложения и что он не был сгенерирован повторно.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.