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

Минимальный путь от регистрации до первого результата проверки. Подробности по каждому шагу — по ссылкам.

1. Зарегистрируйтесь

Создайте аккаунт в личном кабинете. Для регистрации нужен код приглашения. Подробно — Регистрация и вход.

2. Получите API-ключ и разрешите домены

В разделе «Доступ»:

  • вкладка «API-ключи» — «Добавить новый токен доступа». Токен нужен для вызовов REST API;
  • вкладка «Разрешённые домены» — добавьте домены сайта, на котором будет работать виджет. Виджет работает только на доменах из этого списка и только по HTTPS; можно указать маску вида *.example.com. Изменения вступают в силу в течение 2 минут.

Подробно — Токены доступа.

3. Создайте сценарий проверки

Раздел «KYC/AML» → «KYC Редактор» → «Создать сценарий» (или «Создать из шаблона»). Добавьте шаги проверки и сохраните сценарий. На вкладке «Основные настройки» есть «ID Сценария» и «Секретный ключ» — они понадобятся на следующем шаге.

Подробно — KYC/AML в личном кабинете.

4. Запустите проверку

Вариант А: виджет (Web SDK)

Подключите скрипт виджета и вызовите setupKYC, например по клику на кнопку:

<script src="https://kyc.neuro-vision.ru/lib/widget-lib.js"></script>
<script>
  function startKyc() {
    window.KYCWidget.setupKYC({
      scenarioId: "<scenarioId>",
      clientKey: "<clientKey>",
      successCb: (sessionJson) => console.log("success", sessionJson),
      closeCb: () => console.log("closed"),
    });
  }
</script>
  • <scenarioId> — ID сценария из шага 3.
  • <clientKey> — ваш идентификатор пользователя, зашифрованный секретным ключом сценария на вашем сервере. Как его сформировать — Работа с clientKey.

successCb вызывается только при успешной проверке. При отказе клиентского колбэка нет, поэтому итог получайте с сервера (шаг 5).

Все параметры и варианты подключения (React, npm-пакет kyc-widget-nv) — Подключение.

Вариант Б: REST API

Если вы собираете изображения сами, без виджета:

  1. Создайте сессию — kyc/session/create.
  2. Отправьте изображения документа и селфи — kyc/process.

Все методы — POST. Как получить токен и передать его в запросе — Аутентификация.

5. Получите результат

Два способа, их можно совмещать:

  • Вебхук. Укажите адрес своего обработчика в сценарии: вкладка «Настройки коллбека» → «Бэкэнд колбэк URL». Платформа отправит POST-запрос при изменении сессии. Формат уведомления и настройки — Вебхуки.
  • Запрос статуса. Вызовите kyc/session/status по ID сессии или по clientKey.

Значения статусов — на странице Статусы сессии. Решение о клиенте принимайте по статусу с сервера, а не по колбэкам виджета.

Дальше

Перед запуском проверьте интеграцию на тестовом сценарии — Тестирование интеграции.

Если проверка встраивается в мобильное приложение — Мобильные приложения и WebView.