Ошибки OCR API
Этот раздел описывает ошибки метода /document-recognition/recognise.
Назначение
Используйте эту страницу, чтобы обработать ошибки метода /document-recognition/recognise: отделить технические сбои от бизнес-ошибок распознавания и выбрать правильное действие в интерфейсе клиента.
Формат ошибки
Пример ошибки, когда документ не распознан:
{
"title": "DocumentNotRecognized",
"message": "Невозможно произвести извлечение данных из документа."
}
| Поле | Тип | Описание |
|---|---|---|
title |
string | Название ошибки |
message |
string | Описание ошибки |
Коды ошибок
Системные ошибки
| HTTP | Статус | Описание |
|---|---|---|
500 |
system_error |
Ошибка сервиса распознавания |
500 |
internal_error |
Ошибка прокси-сервиса |
500 |
empty_request_body |
Пустое тело запроса |
500 |
not_found_mapping_querry |
Не удалось найти скрипт маппинга |
Бизнес-ошибки
| HTTP | Статус | Описание |
|---|---|---|
400 |
photos_not_found |
Фотографии документов не были найдены |
400 |
empy_mapped_document |
Полученный документ после маппинга является пустым |
400 |
empty_or_correct_type_format |
Некорректный формат типа документа |
400 |
document_type_not_found |
Тип документа не найден в системе |
400 |
empty_photo_document |
На фото отсутствует документ, удостоверяющий личность |
400 |
document_not_recognised |
Невозможно произвести извлечение данных из документа |
400 |
unsupported_document_file_format |
Отправлен неподдерживаемый формат файла |
400 |
tenant_id_not_provided |
Ошибка авторизации: не передан token / Dc Application Id |
Обработка
- Системные ошибки стоит обрабатывать как технические сбои: ретраи, логирование, алерты.
- Бизнес-ошибки стоит обрабатывать на уровне UX: повторное фото, выбор корректного типа документа, пояснение пользователю.
- Если ошибка связана с типом документа, проверьте query-параметр
typeи список поддерживаемых типов.