Два метода REST API запускают проверки физического лица по переданным данным и отдают результат. KYC-сессия и загрузка документа не нужны.
Базовый адрес — https://api.neuro-vision.ru/v1. Все запросы — POST с телом application/json, все ответы — JSON.
| Метод | Назначение |
|---|---|
POST kyc/checks/run | Запускает проверки, сразу возвращает runId |
POST kyc/checks/result | Отдаёт результаты запуска по runId |
Методы асинхронные: результата в ответе на запуск нет. Обращение к внешним реестрам занимает время, поэтому прогон занимает минуты. Клиент забирает результат опросом kyc/checks/result каждые 5–10 секунд, пока checksStatus не станет complete.
Авторизация
Постоянный токен доступа передаётся в поле token тела запроса. Если используется временный токен, он передаётся в заголовке token, и тогда поле в теле не нужно. Запрос без токена получает 401 и {"status": "error", "message": "access denied"}.
Проверки по существующей KYC-сессии
Если проверки идут по сессии KYC, запуск выполняется методом POST kyc/session/databases, а результат приходит вебхуком DATABASE_CHECKS_COMPLETE. Формат элемента results[] тот же, поэтому разбор результата у обеих поверхностей общий.
Тарификация
Тарифицируется каждый запуск проверки. Проверка, вернувшая skipped, до источника не дошла и не тарифицируется.