Skip to content

Определение типа документа

parseDocTypeAutoV3

Тип HTTP запроса: multipart POST

URL вызова: https://api.id-x.org/idx/api2/parseDocTypeAutoV3

Параметры:

Параметр Тип Обязательный Описание
accessKey String Да Ключ доступа, выданный при регистрации в Системе IDX
secretKey String Да Секретный ключ, выданный при регистрации в Системе IDX
file File Да Фотография документа

Проверка распознает следующие форматы: JPG, JPEG, PNG, BMP, TIFF, GIF, PDF, DJVU

Фотография должна соответствовать требованиям к качеству

Функция возвращает:

Параметр Тип Обязательный Описание
resultCode Int Да Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage String Нет Сообщение об ошибке
operationToken String Нет Уникальный идентификатор операции
count Int Нет Количество классифицированных документов
elementList Массив объектов Нет Массив объектов – классифицированных документов. Подробнее см. классифицированный документ

Пример вызова:

POST /idx/api2/parseDocTypeAutoV3 HTTP/1.1
Host: api.id-x.org
Content-Type: multipart/form-data; boundary=----
Accept: application/json

------
Content-Disposition: form-data; name="accessKey"

Выданный accessKey
------
Content-Disposition: form-data; name="secretKey"

Выданный secretKey
------
Content-Disposition: form-data; name="file"; filename="passport.jpg"
Content-Type: image/jpeg

[File data]
------

Пример успешного ответа:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "9b021fae1ece4571ad31aae8a60d2dc3",
    "count": 4,
    "elementList": [*классифицированные документы*]
}

Пример неуспешного ответа:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "9b021fae1ece4571ad31aae8a60d2dc3",
    "count": 1,
    "elementList": [
        {
            "docType": "not_document",
            "docArea": "96.64%"
        }
    ]
}

Требования к качеству изображения

  • Документ должен полностью находиться в рамках изображения; края документа не должны совпадать с краями изображения.

  • Фон должен быть контрастным по отношению к документу (белый документ на белом фоне, так же как и черный документ на черном фоне не может быть распознан).

  • Желательно, чтобы документ занимал 70–80 % площади изображения (это важно, так как даже если размер изображения был 12 MP, но после того, как он был обнаружен и вырезан, его разрешение стало 640×480, то такой документ не будет разпознан корректно).

  • Сжатие JPEG должно быть не менее 70 % от оригинала.

  • Угол наклона должен быть не более 10 градусов в любом направлении (горизонтальном или вертикальном), в противном случае искажение будет слишком сильным для того, чтобы его можно было исправить без ущерба для качества изображения.

  • Для качественного распознавания идентификационных документов любых размеров рекомендуется использовать изображения, полученные при помощи камеры с разрешением Full HD (1920×1080) и с автофокусом.

Классифицированный документ

Это объект, содержащий следующие атрибуты:

Атрибут Тип Описание
docType String Тип документа
docArea String Занимаемая площадь на изображении

Пример объекта "классифицированный документ" в формате json:

{
    "docType": "passport_main",
    "docArea": "29.37%"
}