В этом разделе собраны вспомогательные материалы по терминологии и ключевым понятиям платформы NeuroVision и модуля KYC.
Глоссарий терминов
Общие понятия
KYC (Know Your Customer) — процедура удалённой проверки личности пользователя по документам и фотографиям, с антифрод‑проверками и дополнительными проверками по базам. В платформе NeuroVision это отдельный модуль с собственным API и WebSDK.
KYC‑сессия — единичная проверка пользователя по заданной схеме (например, «паспорт + селфи с документом»). Все загрузки изображений, результаты распознавания, ошибки и статусы привязаны к sessionId.
Схема (schema, schemaId) — сценарий проверки KYC: набор шагов (документ, селфи, Liveness, проверки по базам и т.п.) и настроек (лимиты, антифрод, callback’и). В WebSDK обязательно указывать schemaId.
Сценарий (scenarioId) — устаревшее название схемы проверки; в новых интеграциях нужно использовать schemaId.
Клиент — конечный пользователь вашего сервиса (физическое лицо), проходящий проверку KYC. Не путать с аккаунтом интегратора на стороне NeuroVision.
WebSDK и фронтенд
WebSDK — JavaScript‑библиотека для встраивания KYC‑виджета на сайт или в SPA (React и др.). Отвечает за захват камеры, загрузку изображений и общение с KYC‑backend’ом.
KYC‑виджет — готовое всплывающее окно (popup/modal), в котором пользователь проходит все шаги KYC: фотографирует документ, делает селфи, проходит Liveness.
KYCWidget.setupKYC(...) — основной метод инициализации виджета в браузере. Принимает конфиг (schemaId, clientKey, theme, колбэки) и открывает виджет.
schemaId — идентификатор схемы проверки, настроенной в ЛК. Обязательный параметр для WebSDK.
clientKey (WebSDK) — строка до 36 символов, задаётся на вашей стороне и в зашифрованном виде передаётся в виджет. Используется для привязки KYC‑сессий к вашим пользователям/заявкам и последующей фильтрации в API.
clientUser — необязательная строка до 36 символов, которая раньше использовалась как дополнительный идентификатор клиента. В новых интеграциях обычно не требуется, достаточно clientKey.
closeCb — колбэк, вызываемый при закрытии виджета (успех, ошибка или ручное закрытие).
successCb(payload) — колбэк, вызываемый при успешном завершении сценария KYC. В payload приходит краткая информация о сессии, подробные данные берутся через REST API /kyc/session/status.
Тема (theme) — оформление виджета: light или dark. Можно использовать для визуального соответствия вашему продукту.
REST API и backend
REST API KYC — набор HTTP‑методов для создания сессий, загрузки изображений, проверки статуса и получения списка сессий. Основные методы:
/kyc/session/create, /kyc/process, /kyc/session/status, /kyc/sessions, /kyc/sessions/filter.
/kyc/process — метод, который принимает изображения (документ, селфи и т.п.), распознаёт их и сохраняет результат в сессии. Может работать в режиме sync и async.
/kyc/session/status — метод для получения текущего статуса сессии и детализированных результатов по каждому шагу (документ, селфи, сравнение лиц и т.п.).
/kyc/sessions — список всех KYC‑сессий с краткой информацией и вложенными результатами.
/kyc/sessions/filter — выборка сессий по фильтрам: статус, ошибки, диапазон дат, clientKey, schemaId, проверки по базам и др.
JWT‑токен — временный токен доступа, возвращаемый методом /user/login. Передаётся в заголовке Authorization: Bearer ... и используется во всех защищённых методах API. :contentReference[oaicite:11]{index=11}
Постоянный токен / токен доступа — долговременный токен, создаваемый через /token/create и перечисляемый в /tokens. Удобен для серверных интеграций и сервисных задач.
Вебхук (callback URL) — ваш HTTP‑endpoint, на который платформа может отправлять уведомления о завершении KYC‑сессии. Тело запроса может быть зашифровано; расшифровка выполняется на вашей стороне по заранее согласованному ключу.
Идентификаторы и сущности
sessionId — уникальный идентификатор KYC‑сессии. Используется во всех запросах к API статусов и логов.
clientId — идентификатор клиента в системе KYC (может отличаться от вашего userId).
clientKey (в ответах API) — исходное значение (до 36 символов), которое вы задали при шифровании на backend’е. Позволяет связать KYC‑сессию с вашим пользователем или заявкой.
Список персон (person list) — логическая коллекция записей о лицах (персонах), с которыми можно сравнивать новые изображения: /person, /persons, /person/list/*.
Персона (person) — запись в списке персон: включает данные (поля fields), информацию о лице и, при необходимости, векторные представления.
Группа источников данных (source group) — логическая группа источников изображений/видеопотоков. Управляется методами /source/groups, /source/group/create, /source/group/update и т.п.
Источник данных (source) — конкретный источник изображений, привязанный к группе (например, камера, интеграция, проект). Может иметь настройки автодобавления лиц и признаки, которые нужно определять (feature_check).
Liveness и работа с лицом
Liveness (проверка живости) — набор алгоритмов, подтверждающих, что перед камерой находится живой человек, а не фотография, видео или синтетическое изображение (deepfake). Используется анализ последовательности кадров, микродвижений, текстур и артефактов.
Активный Liveness — режим, когда пользователь выполняет действия (повороты головы, изменение направления взгляда и т.п.), а система проверяет корректность выполнения команд.
Пассивный Liveness — режим, в котором достаточно одного или нескольких кадров без явных заданий, но при этом система определяет признаки реального присутствия.
Сравнение лиц (Face Matching) — оценка похожести двух или более лиц на разных изображениях (документ ↔ селфи, селфи ↔ селфи, селфи с документом ↔ документ). В результатах KYC это отдельный блок с процентом совпадения.
Вектор лица — числовое представление изображения лица (набор чисел), используемое для быстрого поиска похожих лиц. В API называется embeddings и используется, например, в /vector/search.
Fusion‑вектор — объединённое векторное представление лица по нескольким изображениям персоны. Создаётся методом /person/fusion для повышения устойчивости поиска.
OCR, документы и антифрод
OCR (Optical Character Recognition) — распознавание текстовых полей документа (ФИО, даты, номер документа, место рождения и т.п.) из изображения. Блок ocr в ответах KYC содержит поля title, value, conf и статус.
MRZ (Machine Readable Zone) — машиночитаемая зона документа (обычно две или три строки внизу паспорта/ID), содержащая зашифрованные данные и контрольные суммы.
Антифрод‑проверки (fraud checks) — набор детекторов, выявляющих подделки документов и изображений: экранные фото (display), ксерокопии (image printed), редактирование (image edited), подмену лица, логические несоответствия и др.
Чёрный список (black list) — список нежелательных персон или записей; при совпадении с лицом или данными пользователя выдаётся ошибка [fraud] black list.
Коды ошибок KYC — стандартизированные текстовые коды (например, [general] bad image, [document] text fields not visible, [fraud] mobile device), которые объясняют причину неуспешной проверки. Полный список приведён в отдельном справочнике ошибок.
Внешние базы и скоринг
Проверки по внешним базам — дополнительные запросы в гос‑реестры, налоговые и судебные базы, санкционные списки и другие источники данных (банкротства, санкции, задолженности и др.). Эти проверки могут влиять на общий статус KYC‑сессии.
Финансовый скоринг — оценка рисков по данным кредитных бюро и дополнительных источников (например, скоринг дефолта по коротким займам).
Статус сессии KYC — итоговый статус проверки: success, failed, idle, иногда suspicious. Общий success возможен только при успешном прохождении всех критичных проверок (документ, лицо, Liveness, антифрод, внешние базы).