Изображение JPG или PNG
REST API принимает файл до 10 МиБ в multipart-поле file. Для MCP тот же документ передаётся в base64; произвольные URL изображений не принимаются.
REST API для разработчиков
OCR API для распознавания паспортов и российских документов
Передайте изображение документа и получите распознанные поля в JSON. Асинхронный API помогает сократить ручной ввод при заполнении форм и карточек CRM.
10 распознаваний бесплатно один раз на аккаунт.
Как работает распознавание документа
Отдельное задание
Загрузка возвращает HTTP 202 и идентификатор задания. Получайте состояние и результат отдельным GET-запросом, не загружая документ повторно.
Структурированные поля
В зависимости от документа и качества изображения могут быть извлечены ФИО, дата рождения, номер и другие поля. Набор и заполненность определяются распознаванием.
Фото и срок результата
Если фотография распознана, она доступна в result.OCR.photo как base64, иначе поле равно null. Результат задания доступен в течение 24 часов.
OCR извлекает текст и поля, но не подтверждает личность, подлинность или действительность паспорта по базам МВД. Проверьте результат перед сохранением; распознанные значения могут содержать ошибки.
Попробуйте OCR API онлайн
Реальный ответ сервиса без API-ключа. Для интеграции создайте свой ключ в кабинете.
Ответ APIJSON
Ответ появится здесь
Из изображения — в поля вашей формы
Используйте OCR для предварительного заполнения данных, затем покажите результат человеку для проверки. Чёткий снимок без бликов и обрезанных краёв помогает избежать ошибок ручной корректировки.
- Создайте API-ключ со scope ocr и подготовьте JPG/PNG.
- Отправьте файл с уникальным Idempotency-Key и сохраните job.id из ответа.
- Опрашивайте GET /ocr/v1/jobs/{id}; после succeeded сопоставьте распознанные поля с вашей формой.
Пример запроса к OCR API
curl -X POST 'https://api.ibop.ru/ocr/v1/jobs' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Idempotency-Key: YOUR_UNIQUE_REQUEST_ID' \ -F 'file=@document.jpg' # Статус и результат задания curl 'https://api.ibop.ru/ocr/v1/jobs/JOB_ID' \ -H 'Authorization: Bearer YOUR_API_KEY'
Получите ключ после входа через MAX и передавайте его в Authorization: Bearer YOUR_API_KEY. Область доступа ключа должна включать ocr. Храните секрет на сервере своей интеграции.
Основные поля ответа JSON
Полный ответ можно увидеть в демо. Отсутствующие справочные данные могут иметь значение null; учитывайте это в интеграции.
| Поле | Значение |
|---|---|
job.id | Идентификатор принятого задания для дальнейшего опроса. |
job.status | queued, processing, succeeded или failed. |
job.result | Распознанный результат после succeeded; состав полей зависит от документа. |
job.result.OCR.photo | Фотография в base64 JPEG/PNG или null. |
job.error_code, job.expires_at | Код ошибки при failed и время окончания доступности результата. |
Авторизация, ошибки и учёт запросов
Некорректные входные данные возвращают HTTP 422. Ошибки доступа требуют проверки ключа и его областей. При исчерпании квоты API отвечает HTTP 429 с кодом quota_exceeded; ограничения частоты запросов действуют отдельно. Ошибка провайдера возвращает зарезервированную единицу квоты.
После HTTP 202 сохраните job.id. Статусы задания: queued, processing, succeeded или failed. Результат находится в job.result; опрос не расходует дополнительные единицы. После истечения срока доступности API возвращает HTTP 410.
Тарифы OCR API
Цены и квоты загружаются из действующего каталога API.
Бесплатно
0 ₽разовый пакет
10распознаваний
Получить API-ключСтарт
390 ₽/ месяц
1 000распознаваний
Выбрать тарифПро
2 900 ₽/ месяц
10 000распознаваний
Выбрать тарифREST API и авторизованный MCP используют общие квоты аккаунта по каждому продукту. Бесплатный месяц считается по московскому времени. Платный период начинается после подтверждения оплаты. Заказ сам по себе не активирует пакет; оплата подтверждается вручную, автоматических списаний нет.
Вопросы о OCR API
Зачем нужен Idempotency-Key?
Заголовок обязателен при создании OCR-задания. Повтор того же документа с тем же ключом возвращает существующее задание. Для нового документа используйте новый ключ: повтор ключа с другим изображением вызывает конфликт.
Оплачивается ли каждый запрос статуса?
Опрос своего задания не расходует дополнительные распознавания. После загрузки сохраняйте ID и проверяйте статус, вместо того чтобы создавать повторные задания.
Сколько хранится результат?
Срок доступности результата — 24 часа. Сохраните необходимые поля в своей системе до истечения срока; просроченный запрос возвращает HTTP 410.
Это проверка паспорта на подлинность?
Нет. Сервис предназначен для распознавания полей с изображения. Он не сверяет документ с МВД и не устанавливает личность предъявителя.