KYC ПЛАТФОРМА

Флоу и события

Общий флоу идентификации

Типовой KYC-сценарий состоит из четырёх этапов: подготовка заявителя, запуск идентификации по workflow, прохождение сценария пользователем и получение результата.

  1. Подготовка заявителя — клиент создаёт или обновляет заявителя, если нужно заранее передать известные данные пользователя.
  2. Запуск workflow — клиент создаёт заявку методом POST /identifications/workflow-instances.
  3. Сбор данных — пользователь проходит сценарий в веб-модуле, по ссылке, через iframe/WebSDK или Mobile SDK.
  4. Получение результата — клиент получает callback и забирает полные данные заявки через API.

1. Подготовка заявителя

Если в вашей системе уже есть данные пользователя, создайте заявителя заранее и передайте внешний идентификатор. Это помогает связать последующие заявки с клиентом в вашей системе.

POST /api/v2/applicants

Подробнее см. API: Создать заявителя.

2. Запуск идентификации по workflow

Для новых интеграций заявка создаётся через workflow. Workflow уже содержит настройки сценария: шаги, проверки, интерфейс, callback-и и правила обработки.

POST /api/v2/identifications/workflow-instances

Подробнее см. API: Workflow instances.

В ответе платформа возвращает идентификатор заявки и ссылку прохождения. Ссылку можно передать пользователю напрямую, открыть в iframe/WebSDK, использовать в мобильном приложении или отправить по согласованному каналу.

3. Сбор данных пользователем

Пользователь проходит шаги, заданные в workflow. Сценарий может включать:

  • загрузку и распознавание документа;
  • селфи или видео для сверки лица;
  • ввод или подтверждение адреса;
  • Mobile ID;
  • согласия на обработку данных;
  • дополнительные проверки и скоринги.

4. Обработка и результат

После сбора данных платформа обрабатывает заявку: распознаёт документы, выполняет сверки и проверки, применяет правила workflow и переводит заявку в финальный статус.

Финальный статус можно получить двумя способами:

  • через server-to-server callback;
  • через API-метод получения заявки.
GET /api/v2/applicants/{externalId}/identifications/{requestGuid}

Подробнее см. API: Получить заявку и Callback / PostMessage.

События и статусы

В процессе идентификации заявка меняет статусы. Для интеграции обычно важны финальные статусы:

  • identificationSucceeded — пользователь успешно прошёл идентификацию;
  • identificationFailed — идентификация не пройдена;
  • systemError — сценарий завершился системной ошибкой;
  • identificationManuallyAccepted — заявка одобрена вручную;
  • identificationManuallyRejected — заявка отклонена вручную.

Если нужно разобрать путь пользователя по шагам, используйте timeline заявки.

GET /api/v2/applicants/{externalId}/identifications/{requestGuid}/timeline

Что смотреть дальше