Автоматическое распознавание основных полей паспортов Республики Беларусь

parseAuto/multiple/passportBelarus

Данный вызов недоступен в личном кабинете

Для подключения обратитесь на support@iidx.ru

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

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

Параметры:

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

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

Фотография должна соответствовать требованиям к качеству На фото/скане должен находиться один основной разворот документа (там где основная информация о персоне) Если документ представляет собой id карту - то должна быть либо одна сторона, либо обе

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

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

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

POST /idx/api2/parseAuto/multiple/passportBelarus 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="file.jpg"
Content-Type: image/jpeg

[File data]
------

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "faea0efca87d4972b9778977c0ec261c",
    "items": [*поле типа документа и объекты полей паспорта Республики Беларусь*]
}

Примеры ответов с разными сторонами и образцами документа

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

{
    "resultCode": -27,
    "resultMessage": "Некорректное изображение."
}

Поле типа документа и объектов полей паспорта Республики Беларусь

Тип объекта Item:

Параметр	Тип	Описание
docType	String	Тип документа
fields	Массив типа Field	Массив объектов – поля считанные с паспорта Республики Беларусь Подробнее см. поля считанные с паспорта Республики Беларусь

Пример объекта "Поля считанные с паспорта Республики Беларусь" в формате json:

{
    "docType": "...",
    "fields": [*Поля считанные с паспорта*]
}

Поля считанные с паспорта

Тип объекта Field:

Параметр	Тип	Описание
text	String	Значение атрибута
confidence	Double	Индекс корректности распознавания

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

Атрибут	Тип	Описание
authorityEng	Field	Орган который выдал
mrzType	Field	Тип mrz
issuingStateCode	Field	Код региона/страны
personalNumber	Field	Персональный номер
fullNameEng	Field	ФИ на английском
lastNameEng	Field	Фамилия на английском
issuingStateNameEng	Field	Имя региона/страны
expiryDate	Field	Дата окончания действия
nameEng	Field	Имя на английском
number	Field	Номер документа или серия + номер
nationalityCode	Field	Код национальности
mrz	Field	Строка mrz
nameBelarusian	Field	Имя на беларусском
sexBelarusian	Field	Пол на беларусском
lastNameBelarusian	Field	Фамилия на беларусском
nationalityBelarusian	Field	Национальность на беларусском
documentClassCode	Field	Код типа документа
nationalityEng	Field	Национальность на английском
fullNameBelarusian	Field	Полное имя на беларусском
issueDate	Field	Дата выдачи
sexEng	Field	Пол на английском
birthDate	Field	Дата рождения
midNameBelarusian	Field	Отчество на беларусском
authorityBelarusian	Field	Орган который выдал на беларусском

Пример Item, некоторые поля могут не возвращаться в зависимости от документа:

{
        "docType": "some text",
        "fields": {
            "authorityEng": {
                "text": "some text",
                "confidence": 0.95
            },
            "mrzType": {
                "text": "some text",
                "confidence": 0.71
            },
            "issuingStateCode": {
                "text": "some text",
                "confidence": 1.0
            },
            "personalNumber": {
                "text": "some text",
                "confidence": 1.0
            },
            "fullNameEng": {
                "text": "some text",
                "confidence": 0.71
            },
            "lastNameEng": {
                "text": "some text",
                "confidence": 0.9
            },
            "birthDate": {
                "text": "some text",
                "confidence": 1.0
            },
            "expiryDate": {
                "text": "some text",
                "confidence": 1.0
            },
            "issuingStateNameEng": {
                "text": "some text",
                "confidence": 0.71
            },
            "nameEng": {
                "text": "some text",
                "confidence": 1.0
            },
            "number": {
                "text": "some text",
                "confidence": 1.0
            },
            "nationalityCode": {
                "text": "some text",
                "confidence": 0.7
            },
            "mrz": {
                "text": "some text",
                "confidence": 0.83
            },
            "documentClassCode": {
                "text": "some text",
                "confidence": 1.0
            },
            "nationalityEng": {
                "text": "some text",
                "confidence": 0.84
            },
            "issueDate": {
                "text": "some text",
                "confidence": 1.0
            },
            "sexEng": {
                "text": "some text",
                "confidence": 1.0
            }
        }
    }