...

OCR API и SDK для распознавания документов

API распознавания документов NeuroVision принимает фото или скан, сам определяет тип документа и возвращает JSON: поля, уровень уверенности по каждому полю и результаты антифрод-проверок. Подключите REST API к бэкенду или Web SDK к сайту — в облаке в России или в своём контуре.

OCR API: фото документа на смартфоне отправляется на распознавание
  • JSON с полями и уверенностью по каждому полю
  • REST API и Web SDK для сайта и мобильного браузера
  • Облако в России или Docker в вашем контуре
Данные хранятся в России Реестр российского ПО №19972 152‑ФЗ

Как работает OCR API: от изображения до JSON

Один запрос — один ответ. Вашему бэкенду не нужно выбирать тип документа, вырезать поля и считать контрольные суммы: это делает сервис. Нужно сверить лицо с документом или проверить живое присутствие? Это другие шаги того же API — KYC и Liveness.

Шаг 1

1. Получаете токен

Постоянный токен создаётся в личном кабинете в разделе «Доступ», временный — запросом POST /user/login. Токен передаётся в заголовке или полем token в теле запроса.

Создание токена доступа к OCR API в личном кабинете NeuroVision
Шаг 2

2. Отправляете изображения

POST /kyc/process принимает одно или несколько изображений в multipart/form-data: например, разворот паспорта и страницу с пропиской. Режим — синхронный или асинхронный.

Отправка изображений документа в OCR API одним запросом
Шаг 3

3. Сервис распознаёт документ

Нейросеть находит документ на фото, определяет страну и тип, выравнивает изображение, делит его на поля и читает каждое. Параллельно идут антифрод-проверки: редактирование, фото с экрана, распечатка.

OCR API выделяет поля документа и читает каждое из них
Шаг 4

4. Получаете JSON

В ответе — тип документа, код страны, поля с уровнем уверенности, статусы проверок и ошибки. В асинхронном режиме результат приходит на ваш callback URL или по запросу статуса.

Ответ OCR API в JSON: поля документа, уверенность и проверки

Что возвращает API: поля ответа и уверенность распознавания

Обычный OCR отдаёт сплошной текст, и разбирать его приходится вашему коду. OCR API NeuroVision возвращает уже разложенные данные: каждое поле с названием, значением и уровнем уверенности модели. Поля с высокой уверенностью можно сразу записывать в анкету, CRM или АБС, а сомнительные — показать пользователю или оператору. Так сервис работает как IDP-система — подробнее на странице распознавания документов.

  • Сессия и ваша система

    Итог проверки и связь результата с вашим пользователем или заявкой.

    Описание статуса сессии

    Итог сессии

    • status — idle, processing, success, failed, suspicious, exception, expired
    • sessionId — UUID v1 (timeuuid) сессии
    • spent — общее время обработки в секундах
    • isClientNew — первый визит клиента или повторный

    Связь с вашей системой

    • clientKey — клиентский ключ, до 36 символов; по нему ищут сессию
    • schemaId / scenarioId — схема (сценарий) KYC из личного кабинета
    • callback URL — вебхук с финальным результатом сессии
  • Документ и его поля

    Результат по каждому изображению — элемент results[]; меняется только набор полей документа.

    Описание метода

    Документ

    • type — document, selfie, faces
    • docName — тип документа, например Passport (2006)
    • countryCode — страна, ISO 3166-1 alpha-3 (RUS)
    • isBackSide — обратная сторона или нет
    • tries — число попыток распознавания

    Поля ocr.fields[]

    • title — название поля
    • value — значение
    • conf — уровень уверенности распознавания
  • Проверки и ошибки

    Почему сессия могла не пройти, даже если поля прочитаны.

    Справочник ошибок

    Антифрод checks[] (fraud)

    • isEdited — документ не редактирован
    • isDisplay — не сфотографирован с экрана
    • isPrinted — документ напечатан, не фото экрана
    • isXerocopy — не ксерокопия
    • isMRZValid — MRZ-зона валидна
    • isFieldsModified, isStampsOk, isCropped и другие — у каждой проверки status и caption

    Ошибки и объекты

    • errors[] — например [document] unknown document type
    • imageObjects[] — распознанные объекты: штампы, подписи

Какие документы и файлы принимает OCR API

Тип документа сервис определяет сам. От интеграции нужно только одно — передать читаемое изображение в правильном формате.

  • 16 000+ типов документов

    Паспорта, ID-карты, водительские удостоверения, виды на жительство 195+ стран и территорий: кириллица, латиница и другие письменности.

    Полный список документов
  • Многостраничные документы

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

    Распознавание паспорта
  • Тип документа — автоматически

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

  • Форматы: JPEG и PNG

    Сервис принимает только JPEG и PNG. HEIC, WEBP и PDF отклоняются с ошибкой [general] bad image — конвертируйте их на своей стороне до отправки.

  • Размер и качество фото

    Лицо — от 30×30 пикселей. Без бликов, сильного сжатия и обрезанных краёв: документ должен быть в кадре целиком.

    Почему переснимают документы
  • Сканы и копии

    По умолчанию антифрод отмечает распечатки, ксерокопии и фото с экрана. Если в процессе нужны сканы, эти проверки отключаются в редакторе сценария.

Web SDK: виджет съёмки документа для сайта и мобильного браузера

Web SDK — готовый JavaScript-виджет. Он открывается поверх вашей страницы, просит доступ к камере, подсказывает, как снять документ, и сам отправляет снимки в API: инструкция → съёмка в рамке → проверка качества с подсказкой → завершение. Итог приходит вебхуком на ваш бэкенд; колбэк successCb на фронтенде срабатывает только при успешном итоге.

Web SDK NeuroVision в мобильном браузере: рамка для съёмки документа
Web SDK: короткая инструкция перед съёмкой документа Web SDK: экран «Документ принят»

Мобильное приложение: WebView вместо нативного SDK. Отдельных библиотек для iOS и Android сейчас нет. Виджет адаптивный и работает с камерой смартфона, поэтому в мобильном приложении его открывают во встроенном браузере или WebView. Ограничение: внутри cross-origin iframe браузер блокирует камеру, поэтому виджет нельзя вкладывать в чужой iframe.

clientKey шифруется на вашем сервере ключом сценария (пример — AES-256-CBC на Node.js в документации) и только потом передаётся в браузер: работа с clientKey, параметры виджета. Оформление: светлая или тёмная тема (theme), «матовое стекло» поверх страницы (blurHost), встраивание внутрь блока (mountElementId), колбэки successCb, closeCb, finalizedCb, «липкая» сессия на 15 минут (stickySession), выбор языка. Без интеграции — прямая ссылка на виджет или одноразовые KYC-ссылки из личного кабинета, до 1 000 штук за раз.

Облачное распознавание документов или установка в контуре: сравнение

  • Где работает, запуск и масштаб

    Облако — изображения обрабатываются на серверах NeuroVision в России, запуск после выдачи токена и настройки сценария, масштабирование на стороне NeuroVision. В вашем контуре (on‑premises) — на ваших серверах, без выхода во внешние сервисы; Docker-контейнеры на ваши серверы устанавливают инженеры NeuroVision; масштабирование — ваши серверы, для продуктива два сервера с балансировщиком.

  • Интернет и обновления моделей

    Облако — интернет нужен для запросов к API, модели обновляются автоматически, без вашего участия. В вашем контуре — интернет не нужен для работы, нужен для активации лицензии и обновлений, их можно ставить офлайн-пакетами; модели обновляются по согласованию: инженеры NeuroVision подключаются по защищённому каналу и тестируют после обновления.

  • Оплата и кому подходит

    Облако — оплата за распознанные документы или пакетами; подходит онлайн-сервисам, финтеху и маркетплейсам, которым нужен быстрый запуск. В вашем контуре — лицензия; подходит банкам, госкомпаниям, медицине и всем, у кого изолированный контур.

Ядро одно и то же — меняется место, где работает сервис, и кто его обслуживает. Облачный OCR-сервис NeuroVision подходит для быстрого старта, установка в контуре — когда документы не должны покидать периметр. Функции API в обоих вариантах одинаковые: тот же метод, тот же JSON.

OCR в Docker: требования к серверу и обновления

  • Минимальная конфигурация

    CPU от 16 потоков с AVX2 (AMD Ryzen 9 3900X или аналог), NVIDIA RTX 3090 24 ГБ или аналог (A5000, RTX 4080), ОЗУ 64 ГБ, SSD от 1 ТБ.

  • Рекомендуется

    CPU от 24 потоков (Intel Core i9-12900KF или аналог), 2× RTX 3090 (48 ГБ) или аналог (2× A5000, A6000, RTX 4090), ОЗУ 128 ГБ, SSD/NVMe от 2 ТБ, сеть от 1 Гбит/с.

  • Установка и обновления

    Вы готовите серверы и доступ по SSH или защищённому каналу, инженеры NeuroVision ставят контейнеры и проверяют работу. Обновления — по согласованию: новая версия включается только после тестов.

Изображения и результаты не покидают периметр.
Интернет нужен только для активации лицензии и обновлений.

Производительность и лимиты OCR API

Цифры из документации NeuroVision

Проверьте их на своих документах и нагрузке. Как измерять качество OCR — в статье о точности AI OCR

  • 01

    Время обработки

    На production-серверах полная проверка документа — загрузка, распознавание, извлечение полей и проверки — в среднем 500–600 мс, на демо-стенде — до 5 секунд. Фактическое время сессии — в поле spent.

  • 02

    Синхронный и асинхронный режим

    mode=sync — результат в том же HTTP-ответе, удобно для анкеты. mode=async — сразу sessionId, результат — вебхуком или запросом POST /kyc/session/status. В примерах документации таймаут клиента — 30 и 120 секунд.

  • 03

    Лимиты и пакеты

    По тарифу нет ограничений частоты запросов: пакет можно израсходовать за день или за год. Закончился пакет — сервис не блокируется, нужно докупить следующий. Нагрузку обсуждаем на старте теста.

  • 04

    Сколько хранятся данные

    Результаты доступны по sessionId через API и в личном кабинете, срок задаётся в сценарии. Оригиналы изображений хранятся 6 месяцев и удаляются. В контуре сроки определяете вы.

  • 500–600 мс полная проверка документа на production
  • без лимита частоты запросов по тарифу
  • 6 месяцев хранятся оригиналы изображений

Авторизация, версии и коды ошибок OCR API

  • Постоянный токен ЛК → «Доступ» или /token/create
  • Временный JWT POST /user/login, valid_days
  • Как передать токен заголовок token (JWT) или поле token в теле (постоянный токен)
  • Базовый адрес api.neuro-vision.ru/v1/
  • Без токена access denied (401)

  • [general] bad image — переданный файл не является изображением конвертировать в JPEG или PNG
  • [general] too small image — изображение слишком маленькое для распознавания переснять без сжатия
  • [general] no documents on image — на изображении не найдены документы проверить, что документ в кадре
  • [document] text fields not visible — поля не видны попросить переснять
  • [fraud] mobile device — фото сделано с экрана мобильного устройства запросить фото оригинала
  • Ошибки бывают двух видов. Ошибка запроса — HTTP 400 invalid schema (неверные параметры или нет изображения), 401 access denied, 403 invalid user credentials. Ошибка распознавания приходит в обычном ответе: status: failed и причина в results[].errors в формате [группа] описание.
  • failed не всегда значит «не прочитали»: поля могут быть распознаны, но сессия не пройдёт из-за низкой уверенности или антифрод-проверки. Смотрите errors и checks в каждом элементе results.
  • Полный справочник с описанием технологии каждой проверки — Ошибки KYC.

Быстрый старт: первый запрос к OCR API за 5 шагов

От заявки до первого JSON. Разработчику понадобится один вечер, остальное — организационные шаги на нашей стороне.

Шаг 1

1. Получите тестовый доступ

Оставьте заявку — менеджер выдаст доступ к личному кабинету. Тестовый доступ — 1 месяц.

Тестовый доступ к OCR API: заявка и личный кабинет
Шаг 2

2. Создайте токен

В личном кабинете откройте раздел «Доступ» (Access Tokens), создайте токен (при необходимости укажите дату окончания). Сохраните его как секрет.

Создание токена доступа в разделе «Доступ»
Шаг 3

3. Настройте сценарий

В разделе «KYC/AML» создайте сценарий: какие документы и страны принимать, какие проверки включать, callback URL для вебхуков. Скопируйте его идентификатор.

Настройка сценария: документы, проверки, callback URL
Шаг 4

4. Отправьте первое изображение

Выполните запрос POST /kyc/process по документации метода с вашим токеном и сценарием. Для первого раза хватит одного фото документа. Сначала посмотреть, как это работает, можно в демо.

Первый запрос к OCR API с токеном и сценарием
Шаг 5

5. Разберите ответ и подключите вебхук

Запишите поля в свою систему, обработайте failed и низкую уверенность. Для продуктива включите асинхронный режим и вебхук с шифрованием.

Разбор ответа и подключение вебхука

Стоимость OCR API и тестовый доступ

Платите только за распознанные документы: поштучно или пакетами, без ограничений по скорости расхода. Первый месяц — бесплатный тест.

Рассчитать стоимость
  • 01

    Оплата за распознанные документы, поштучно или пакетами

  • 02

    Годовой пакет со сниженной ценой для больших объёмов

  • 03

    Установка в вашем контуре — по лицензии

Лицензии и сертификаты

Фонд содействия инновациям

Проект «Разработка мультимодальной системы с применением искусственного интеллекта "Neuromed" для управления диагностическими процессами клиники на базе платформы компьютерного зрения "Нейровижн"» поддержан Фондом содействия инновациям в рамках реализации федерального проекта «Отечественные решения»

Получите тестовый доступ к OCR API

Расскажите, какие документы и в каком объёме нужно распознавать и где должен работать сервис — в облаке или в вашем контуре. Выдадим доступ к личному кабинету и поможем с первым запросом.

Не можете сформулировать запрос? Запишитесь на звонок, и наша команда свяжется с вами в удобное время

Записаться на звонок

Компания внесена в реестр IT-компаний и реестр операторов персональных данных Минцифры России.

Адрес: Москва, Пресненская наб., д. 12 — деловой центр «Москва-Сити», башня «Федерация». Ближайшие станции метро — «Деловой центр» и «Международная».

Частые вопросы об OCR API и SDK

Ответы о методах, SDK, развёртывании в Docker, форматах, скорости, данных и тестовом доступе

Это REST API, который принимает изображение документа и возвращает распознанные поля в JSON. Сервис сам определяет страну и тип документа, читает поля, проверяет изображение на редактирование и фото с экрана и указывает уровень уверенности по каждому полю.

POST /kyc/process по адресу https://api.neuro-vision.ru/v1/. В запросе — токен, одно или несколько изображений в поле images и идентификатор сценария. Статус асинхронной сессии запрашивается методом POST /kyc/session/status.

Отдельных серверных библиотек нет: API работает по обычному HTTP, поэтому подходит любой язык. В документации есть готовые скрипты на Python.

Нативных SDK для Android и iOS сейчас нет. Web SDK работает в мобильных браузерах и открывается внутри приложения через WebView, поэтому съёмку документа можно встроить и в мобильное приложение.

Да. Сервис устанавливается в вашем контуре как набор Docker-контейнеров, установку и обновления выполняют инженеры NeuroVision. После установки он работает без интернета: доступ нужен только для активации лицензии и обновлений.

Минимальная конфигурация из документации — CPU от 16 потоков с AVX2, NVIDIA RTX 3090 с 24 ГБ видеопамяти или аналог, 64 ГБ ОЗУ и SSD от 1 ТБ. Для продуктива с высоким SLA рекомендуются два сервера с балансировщиком нагрузки.

Только JPEG и PNG. Файлы HEIC, WEBP и PDF отклоняются с ошибкой [general] bad image, поэтому их нужно конвертировать до отправки.

По документации на production-серверах полная проверка документа занимает в среднем 500–600 мс, на демо-стенде — до 5 секунд. Фактическое время каждой сессии возвращается в поле spent.

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

В облаке — на серверах NeuroVision в России, при установке в контуре — только на ваших серверах. Срок хранения результатов настраивается в сценарии, изображения удаляются через 6 месяцев, а вебхуки можно отправлять без персональных данных.

Да, тестовый доступ даём на 1 месяц с личным кабинетом, токеном и документацией. Оставьте заявку внизу страницы.

Обычный OCR возвращает сплошной текст, и разбирать его приходится вам. OCR API NeuroVision возвращает поля с названиями и уровнем уверенности, тип и страну документа и результаты антифрод-проверок изображения.