# Обзор API

OneKYC предоставляет два публичных HTTP-API для интеграции с тенант-серверами:

- **Tenant API (KYC)** — управление верификацией физических лиц (аппликантов): создание сессий и ссылок верификации, получение результатов, OCR-данных, AML-скрининга, **ручное ревью**, статистики и аудита.
- **KYB API** — отдельная поверхность для верификации юридических лиц (включая **KYB review tasks**). См. [KYB API](/ru/kyb).

Обе поверхности доступны на API-домене вашего тенанта. Tenant API смонтирован на префиксе `/tenant/v1/kyc/...`, KYB API — на `/tenant/v1/kyb/...`.

## Аутентификация [#аутентификация]

Все запросы серверного взаимодействия подписываются по схеме **HMAC-SHA256**.

Обязательные заголовки:

- `Authorization: HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>`
- `X-Timestamp: <unix_seconds>` — допустимое расхождение с временем сервера ±5 минут.

Строка для подписи: `timestamp\nmethod\npath\nbody_hash`, где `body_hash` — lowercase hex SHA256 digest исходного тела запроса. Для запросов без тела используйте пустую строку.

Полное описание алгоритма, примеры на JavaScript / Python / Go, формат идентификаторов ключей (`kyc_live_*` / `kyc_test_*` / `kyb_live_*` / `kyb_test_*`) и список scopes — в разделе [Аутентификация](/ru/api/authentication).

## Окружения [#окружения]

| Окружение | Префикс ключа | Назначение |
|-----------|---------------|------------|
| Production | `kyc_live_` / `kyb_live_` | Реальные верификации, биллинг, реальные вебхуки |
| Test | `kyc_test_` / `kyb_test_` | Sandbox-сессии, изолированные данные, бесплатно |

## Структура раздела [#структура-раздела]

- [Аутентификация](/ru/api/authentication) — HMAC, scopes, ротация ключей.
- [Сессии](/ru/api/sessions) — создание / получение / отмена сессий верификации.
- [Аппликанты](/ru/api/applicants) — карточки пользователей, история, AML-данные.
- [Документы и медиа](/ru/api/documents-and-media) — типы поддерживаемых документов, presigned URL.
- [Флоу](/ru/api/flows) — справка по сценариям верификации (управление через [админ-панель](/ru/admin/flows)).
- [Ссылки верификации](/ru/api/verification-links) — генерация ссылок и QR-кодов для пользователей.
- [Задачи ревью](/ru/api/review) — очередь manual review и решения для интеграторов (HMAC).
- [Вебхуки](/ru/api/webhooks) — асинхронные уведомления о событиях, формат подписи, retry-политика.
- [Метрики и аналитика](/ru/api/metrics) — агрегаты по сессиям, конверсия, экспорт.
- [Аудит](/ru/api/audit) — журнал действий со стороны API.
- [Ошибки и ограничения](/ru/api/errors-and-limits) — коды ошибок, rate limits, OTP-параметры.
- [Справочник API (Swagger / OpenAPI)](/ru/api/api-reference) — машиночитаемая спецификация.