Автоматическое распознавание основных полей Украинского паспорта

parseAuto/multiple/passportUkraine

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

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

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

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

Параметры:

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

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

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

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

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

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

POST /idx/api2/parseAuto/multiple/passportUkraine 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	Индекс корректности распознавания

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

Атрибут	Тип	Описание
birthDate	Field	Дата рождения
birthPlace	Field	Место рождения
firstName	Field	Имя
passportNumber	Field	Номер паспорта
lastName	Field	Фамилия
midName	Field	Отчество
expiryDate	Field	Дата истечение срока
passportNumberFront	Field	Номер паспорта
firstNameEngFront	Field	Имя (Eng)
firstNameFront	Field	Имя
nationality	Field	Национальность
midNameFront	Field	Отчество
recordNumber	Field	Номер записи
gender	Field	Пол
lastNameEngFront	Field	Фамилия (Eng)
lastNameFront	Field	Фамилия
issueDate	Field	Дата выдачи
issuer	Field	Кем выдан
mrz	Field	Мрз
rntrc	Field	РНОКПП
issuerRus	Field	Кем выдан (RUS)
issuerUkr	Field	Кем выдан (URK)
seriesAndNumber	Field	Серия и номер

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

Пример успешного ответа, при отправке основного оборота Украинского паспорта 1994 года образца в виде json:

{
        "docType": "ukr_passport_main_1994_printed",
        "fields": {
            "birthDate": {
                "text": "26.03.1988",
                "confidence": 0.9970301389694214
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "passportNumber": {
                "text": "...",
                "confidence": 0.5898985862731934
            },
            "birthPlace": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "midName": {
                "text": "...",
                "confidence": 0.9915384650230408
            }
        }
    }
}

Пример успешного ответа, при отправке второй страницы Украинского паспорта 1994 года образца в виде json:

{
        "docType": "ukr_passport_main_rus_1994_printed",
        "fields": {
            "birthDate": {
                "text": "26.03.1988",
                "confidence": 0.9970301389694214
            },
            "issueDate": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "issuerRus": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "issuerUkr": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "midName": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "birthPlace": {
                "text": "город",
                "confidence": 0.9915384650230408
            },
            "seriesAndNumber": {
                "text": "...",
                "confidence": 0.5898985862731934
            },
            "sex": {
                "text": "ЖЕНСКИЙ",
                "confidence": 0.5898985862731934
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

Пример успешного ответа, при отправке лицевой стороны Украинского паспорта образца пластиковой карты в виде json:

{
        "docType": "ukr_passport_2016_front",
        "fields": {
            "birthDate": {
                "text": "06.02.1999",
                "confidence": 0.9970301389694214
            },
            "expiryDate": {
                "text": "22.11.2026",
                "confidence": 0.5898985862731934
            },
            "passportNumberFront": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "firstNameEngFront": {
                "text": "...",
                "confidence": 0.9643449187278748
            },
            "firstNameFront": {
                "text": "...",
                "confidence": 0.9991969466209412
            },
            "nationality": {
                "text": "УКРАÏНА/UКR",
                "confidence": 0.9991969466209412
            },
            "midNameFront": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "recordNumber": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "gender": {
                "text": "Ж/F",
                "confidence": 0.9983574151992798
            },
            "lastNameEngFront": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "lastNameFront": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

Пример успешного ответа, при отправке обратной стороны Украинского паспорта образца пластиковой карты в виде json:

    {
        "docType": "ukr_passport_2016_back",
        "fields": {
            "issueDate": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "issuer": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "mrz": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "birthPlace": {
                "text": "11.11.1989",
                "confidence": 0.5898985862731934
            },
            "rntrc": {
                "text": "...",
                "confidence": 0.9991969466209412
            }
        }
    }
}