Перейти к содержанию

Workflow

Workflow — это настроенная последовательность технологий, которую проходит пользователь в рамках одной проверки. Например, базовый KYC-сценарий может состоять из Liveness, Document Recognition и Face2Face.

Каждый запуск Workflow создаёт отдельную сессию. Сессия связывает действия конкретного пользователя, результаты технологий и переданные при запуске метаданные.

Даже одна технология запускается через Workflow

Если для проверки нужна только одна технология, всё равно создайте Workflow, содержащий эту технологию.

Общий процесс интеграции

flowchart LR
    A[Настроить Workflow] --> B[Создать сессию]
    B --> C{Способ интеграции}
    C --> D[Remote]
    C --> E[Widget]
    C --> F[WebView]
    D --> G[Пользователь проходит проверку]
    E --> G
    F --> G
    G --> H[Webhook или событие завершения]
    H --> I[Получить результат]
    I --> J{Итог проверки}
    J -->|Успех| K[Продолжить бизнес-процесс]
    J -->|Отказ| L[Обработать failure_reason]
    I --> M[Создать или обновить персону]
  1. Настройте Workflow в личном кабинете.
  2. Создайте новую сессию на backend клиентской системы.
  3. Передайте пользователю session_id через выбранный способ интеграции.
  4. Дождитесь завершения проверки.
  5. Получите результат на backend и примите бизнес-решение.

Создание Workflow

Откройте раздел создания Workflow в личном кабинете, укажите название и добавьте необходимые технологии.

Порядок технологий определяет последовательность проверок. Например:

  1. Liveness проверяет, что перед камерой находится живой человек.
  2. Document Recognition распознаёт и проверяет документ.
  3. Face2Face сравнивает лицо пользователя с фотографией из документа.

В эксплуатационной среде доступны только технологии, подключённые для вашей организации.

API KEY Workflow

После создания Workflow в личном кабинете доступен его API KEY. Этот ключ используется при создании сессии и получении результата.

Храните API KEY только на backend

API KEY предоставляет доступ к Workflow и результатам его сессий. Не передавайте ключ в браузер, мобильное приложение, публичные URL, клиентские логи или системы аналитики.

Храните соответствие между бизнес-сценарием и API KEY в защищённой конфигурации backend. Frontend или мобильное приложение должны получать только session_id либо готовый URL прохождения.

Изменение Workflow

Изменение состава или порядка технологий влияет на новые сессии Workflow. Если backend ожидает определённые блоки результата, согласуйте изменение Workflow с обновлением клиентской системы.

Рекомендуется использовать отдельный Workflow для каждого самостоятельного контракта проверки: например, для регистрации клиента, повторной идентификации и подписания документов.

Следующие шаги