# Введение Настоящая документация предназначена для разработчиков, осуществляющих интеграцию с платформой OneKYC, а также для пользователей административной панели. Документация содержит описание продукта, руководство по интеграции и справочник API. Подробное описание возможностей платформы приведено в разделе [О продукте](https://finext.gitbook.io/one-kyc/obzor-produkta). **Содержание документации:** * **Введение** — описание функциональных возможностей продукта и целевых сценариев использования. * **Быстрый старт** — пошаговое руководство по созданию ссылки верификации и запуску первой KYC-сессии. * **Tenant API** — описание программного интерфейса для серверной интеграции: [Аутентификация](https://finext.gitbook.io/one-kyc/autentifikaciya), [Сессии](https://finext.gitbook.io/one-kyc/autentifikaciya/sessii), [Аппликанты](https://finext.gitbook.io/one-kyc/autentifikaciya/applikants), [Документы и медиа](https://finext.gitbook.io/one-kyc/autentifikaciya/dokumenty-i-media), [Ссылки верификации](https://finext.gitbook.io/one-kyc/autentifikaciya/ssylki-verifikacii), [Вебхуки](https://finext.gitbook.io/one-kyc/autentifikaciya/vebhuki), [Метрики](https://finext.gitbook.io/one-kyc/autentifikaciya/metriki), [Аудит](https://finext.gitbook.io/one-kyc/autentifikaciya/audit), [Справочник API (OpenAPI)](https://finext.gitbook.io/one-kyc/autentifikaciya/spravochnik-api-swagger). * **KYB API** — верификация юридических лиц: [Обзор KYB](https://finext.gitbook.io/one-kyc/vvedenie-1), [Быстрый старт](https://finext.gitbook.io/one-kyc/vvedenie-1/bystryi-start), [Справочник KYB API](https://finext.gitbook.io/one-kyc/vvedenie-1/api-spravochnik), [KYB Вебхуки](https://finext.gitbook.io/one-kyc/vvedenie-1/vebkhuki). * **Административная панель** — управление дашбордом, сессиями, аппликантами, сценариями верификации (флоу), ревью, API-ключами, вебхуками, ссылками верификации, командой, аудитом и настройками. > **Обратите внимание.** Tenant API OneKYC находится в стадии бета-тестирования. Эндпоинты, форматы данных и версии API могут быть изменены. Рекомендуется отслеживать обновления документации. ## Часто задаваемые вопросы ### Где выполняется верификация — на стороне клиента или на стороне OneKYC? Верификация выполняется **на стороне OneKYC**. Интеграция сводится к созданию ссылки верификации через API и её передаче конечному пользователю (по электронной почте, SMS, QR-коду и пр.). Пользователь переходит по ссылке на страницу верификации OneKYC, где проходит все предусмотренные сценарием проверки. Результаты передаются на сторону клиента посредством вебхуков или запросов к API. ### Возможно ли встроить верификацию в собственный интерфейс? Рекомендуемый подход — **редирект** на страницу верификации OneKYC либо её открытие в **новом окне браузера**. Встраивание через iframe имеет технические ограничения (доступ к камере устройства, полноэкранный режим). Пользовательский интерфейс OneKYC адаптивен и корректно работает как на настольных, так и на мобильных устройствах. ### Как реализован cross-device flow? Пользователь может начать верификацию на настольном компьютере (для заполнения форм) и продолжить на мобильном устройстве (для съёмки документов и селфи). При создании ссылки генерируется QR-код; после сканирования пользователь продолжает ту же сессию на мобильном устройстве. **QR-код действителен в течение 5 минут** и является одноразовым: после сканирования токен аннулируется. В случае истечения срока действия QR-кода необходимо обновить страницу для генерации нового кода. ### Какие типы документов поддерживаются? Поддерживаются паспорта, идентификационные карты и водительские удостоверения большинства стран. Актуальный перечень доступен через API: `GET /v1/documents/supported`. В настройках флоу определяется, какие типы документов допустимы для конкретного сценария верификации. ### Возможно ли настроить сценарий верификации? Да. Настройка сценариев осуществляется через **Flow Editor** в административной панели. Доступны следующие операции: добавление и удаление шагов (загрузка документа, селфи, liveness-проверка, OTP-подтверждение, AML-скрининг, ручное ревью), изменение порядка шагов и их параметров. Изменения применяются к новым сессиям после публикации обновлённой версии флоу. ### Каким образом получать результаты верификации? Предусмотрены два способа: 1. **Вебхуки** (рекомендуемый способ) — OneKYC направляет уведомления о событиях на указанный URL в режиме реального времени (например, `verification.approved`, `verification.declined`). 2. **Polling через API** — периодический запрос статуса верификации через эндпоинт `/v1/applicants/{id}/verification`. ### Какова длительность процедуры верификации? * **Автоматическая верификация** (без ручного ревью) — 30--60 секунд (загрузка документа, селфи, выполнение проверок). * **С ручным ревью** — зависит от загрузки очереди операторов (от нескольких минут до нескольких часов). * **С AML-скринингом** — дополнительно 5--15 секунд. ### Какие действия предпринять, если пользователь не прошёл верификацию? Рекомендуемые действия зависят от причины отклонения (поле `rejection_reason` в ответе API): * **Низкое качество изображения** — рекомендуется предложить пользователю повторить процедуру (создать новую ссылку верификации). * **Истёкший срок действия документа** — рекомендуется уведомить пользователя о необходимости предоставить действующий документ. * **Несовпадение лица** — возможный индикатор мошенничества; рекомендуется ручная проверка или отклонение. * **AML-совпадение** — решение принимается на стороне клиента в соответствии с внутренними процедурами управления рисками. ### Как тестировать интеграцию? 1. Создайте API-ключ с префиксом `kyc_test_` в административной панели. 2. Используйте тестовые ключи в среде разработки/staging. 3. Для тестирования вебхуков рекомендуется использовать ngrok или аналогичные инструменты для локальной разработки. 4. Сессии, созданные с тестовыми ключами, не учитываются в биллинге. ### Возможно ли удаление данных пользователя (GDPR)? Да. Удаление осуществляется через эндпоинт `DELETE /v1/applicants/{applicant_id}`. При этом удаляются все связанные данные (документы, селфи, результаты верификации) в соответствии с требованиями GDPR. Операция является необратимой. ### Как осуществляется тарификация? Тарификация производится на основании количества успешно завершённых верификаций. Тестовые ключи (`kyc_test_*`) не тарифицируются. Информация о тарифных планах доступна в административной панели или у персонального менеджера. *** Для начала работы перейдите к разделу [О продукте](https://finext.gitbook.io/one-kyc/obzor-produkta) или [Быстрый старт](https://finext.gitbook.io/one-kyc/bystryj-start).