# Быстрый старт

Данное руководство описывает минимальный набор действий для запуска верификации пользователей через OneKYC. По завершении четырёх шагов вы получите полностью функционирующую интеграцию: от создания сценария верификации до получения результатов.

---

## Шаг 1. Получение доступа к платформе [#шаг-1-получение-доступа-к-платформе]

1. Получите учётные данные для входа в административную панель OneKYC (предоставляются менеджером или при регистрации).
2. Авторизуйтесь в панели администратора.
3. Перейдите в раздел **API-ключи** и создайте API-ключ типа KYC:
   - **Среда:** выберите `test` для разработки или `live` для продакшена.
   - **Scopes:** выберите необходимые права доступа (для быстрого старта рекомендуется `*` — полный доступ).
4. **Сохраните секрет ключа** — он отображается однократно. Секрет необходим для формирования HMAC-подписи при вызове API.

> **Важно.** Секрет ключа (с префиксом `sk_`) должен храниться исключительно на серверной стороне. Никогда не передавайте его на клиентскую сторону.

---

## Шаг 2. Создание сценария верификации (Flow) [#шаг-2-создание-сценария-верификации-flow]

Перейдите в раздел **Флоу** административной панели:

- **Из шаблона (рекомендуется):** откройте **Галерею шаблонов** и выберите готовый сценарий, например «Стандартный KYC» (документ + селфи + liveness) или «Базовый KYC» (только документ).
- **Вручную:** нажмите «Создать флоу» и добавьте необходимые шаги в визуальном редакторе: загрузка документа, селфи, liveness-проверка, OTP, AML-скрининг, ручное ревью и др.

После настройки **опубликуйте** флоу. Скопируйте **идентификатор флоу** (`flow_id`) — он потребуется на следующем шаге.

---

## Шаг 3. Создание ссылки верификации [#шаг-3-создание-ссылки-верификации]

Существует два способа создания ссылки верификации:

### Способ A. Через Tenant API (рекомендуется для интеграции) [#способ-a-через-tenant-api-рекомендуется-для-интеграции]

Отправьте запрос с серверной стороны, подписав его HMAC-подписью:

API operations:

- `POST /v1/kyc/verification-links`

**Ключевые параметры запроса:**

| Параметр           |    Обязательный     | Описание                                                                                                  |
| ------------------ | :-----------------: | --------------------------------------------------------------------------------------------------------- |
| `flow_id`          |         Да          | Идентификатор опубликованного сценария верификации                                                        |
| `external_user_id` | Нет (рекомендуется) | Идентификатор пользователя в вашей системе. Позволяет связать результат верификации с вашим пользователем |
| `redirect_url`     |         Нет         | URL для перенаправления после завершения верификации                                                      |
| `locale`           |         Нет         | Язык интерфейса (`en`, `ru`)                                                                              |
| `expires_in`       |         Нет         | Время жизни ссылки в секундах (по умолчанию определяется настройками флоу)                                |

**Формирование HMAC-подписи:** подробное описание алгоритма с примерами кода на JavaScript и Go приведено в разделе [Аутентификация](/ru/api/authentication).

В ответе возвращается URL ссылки верификации. Передайте его пользователю по электронной почте, SMS, через мессенджер или в личном кабинете вашего приложения.

### Способ B. Через административную панель (для тестирования) [#способ-b-через-административную-панель-для-тестирования]

Перейдите в раздел **Ссылки верификации** и нажмите «Создать ссылку»:

1. Выберите опубликованный флоу.
2. При необходимости укажите `external_user_id`, `redirect_url` и срок действия.
3. Скопируйте сгенерированную ссылку и откройте её в браузере для прохождения тестовой верификации.

---

## Шаг 4. Регистрация вебхука для получения результатов [#шаг-4-регистрация-вебхука-для-получения-результатов]

Для получения результатов верификации в реальном времени настройте вебхук:

1. Перейдите в раздел **Вебхуки** административной панели.
2. Нажмите «Создать эндпоинт».
3. Укажите URL вашего сервера, на который OneKYC будет отправлять уведомления.
4. Выберите типы событий — для начала рекомендуется подписаться на:
   - `verification.approved` — верификация одобрена
   - `verification.declined` — верификация отклонена
   - `verification.needs_review` — верификация направлена на ручное ревью
5. Сохраните **секрет вебхука** (с префиксом `whsec_`) — он необходим для проверки подлинности входящих уведомлений на вашей стороне.

> **Проверка подписи:** каждый вебхук содержит заголовок `X-Onekyc-Signature` с HMAC-SHA256 подписью. Подробнее о верификации подписи — в разделе [Вебхуки](/ru/api/webhooks).

**Альтернативный способ — запрос через API:**

API operations:

- `GET /v1/kyc/applicants`

---

## Готово! [#готово]

Интеграция завершена. При переходе пользователя по ссылке верификации он проходит сценарий на странице OneKYC, а ваш сервер получает результат через вебхук.

### Дальнейшие шаги [#дальнейшие-шаги]

- **[Аутентификация](/ru/api/authentication)** — детали HMAC-подписи, типы ключей, scopes
- **[Вебхуки](/ru/api/webhooks)** — полный перечень событий, формат payload, верификация подписи, политика повторных попыток
- **[Аппликанты](/ru/api/applicants)** — получение данных верификации, документов, результатов AML
- **[Ссылки верификации](/ru/api/verification-links)** — жизненный цикл ссылок, пакетное создание, QR-коды
- **[Флоу](/ru/api/flows)** — настройка сценариев верификации через API
- **[KYB API](/ru/kyb)** — верификация юридических лиц (бизнес-клиентов)
- **[Ошибки и ограничения](/ru/api/errors-and-limits)** — коды ошибок, rate limits
- **[Справочник API (OpenAPI)](/ru/api/api-reference)** — интерактивная документация всех эндпоинтов