Распознавание паспорта

parseAuto/multiple/passport

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/passport 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": "6933bb2410b74a91bd1cfe8536af4a33",
    "items": [*поле типа документа и объекты полей паспорта*]
}

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

{
    "resultCode": -25,
    "resultMessage": "Источник не доступен. Рекомендуем повторить запрос через 5 минут."
}

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

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

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

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

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

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

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

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

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

Атрибут	Тип	Описание
birthDate	Field	Дата рождения
issueDate	Field	Дата выдачи
firstName	Field	Имя
issuingAuthority	Field	Кем выдан
midName	Field	Отчество
birthplace	Field	Место рождения
passportNumber	Field	Номер паспорта
sex	Field	Пол
subdivisionCode	Field	Код подразделения
lastName	Field	Фамилия
mrz	Field	MRZ
mrzCountry	Field	Страна MRZ
mrzFirstName	Field	Имя MRZ
mrzLastName	Field	Фамилия MRZ
mrzMidName	Field	Отчество MRZ
mrzNumber	Field	Номер MRZ
mrzCheckSum	Field	Контрольная сумма MRZ
mrzCode	Field	Код MRZ
mrzBirthDate	Field	Дата рождения MRZ
mrzNationality	Field	Национальность MRZ
mrzSex	Field	Пол MRZ
mrzIssueDate	Field	Дата выдачи MRZ

Пример объекта "Поля данных считанные с паспрота" в формате json:

{
    "birthDate": {
        "text": "12.01.1990",
        "confidence": 0.9963644742965698
    },
    "issueDate": {
        "text": "12.01.1990",
        "confidence": 0.9952632784843445
    },
    "firstName": {
        "text": "ИВАН",
        "confidence": 0.997851550579071
    },
    "issuingAuthority": {
        "text": "ОТДЕЛОМ УФМС РОССИИ ПО ГОР. МОСКВЕ ПО РАЙОНУ",
        "confidence": 0.8541767597198486
    },
    "midName": {
        "text": "ИВАНОВИЧ",
        "confidence": 0.9996181726455688
    },
    "birthPlace": {
        "text": "ГОРОД МОСКВА",
        "confidence": 0.9998390078544617
    },
    "passportNumber": {
        "text": "4444 123456",
        "confidence": 0.2922857701778412
    },
    "sex": {
        "text": "МУЖ",
        "confidence": 0.9850548505783081
    },
    "subdivisionCode": {
        "text": "770-000",
        "confidence": 0.9984660148620605
    },
    "lastName": {
        "text": "ИВАНОВ",
        "confidence": 0.9998581409454346
    },
    "mrz": {
        "text": "PNRUSIVANOV<<IVAN<IVANOVI3<<<<<<<<<<<<<<<<4444123456RUS1202142M<<<<<<<2560802556056<98",
        "confidence": 0.5003616458344473
    }
    "mrzCountry": null,
    "mrzFirstName": null,
    "mrzNumber": null,
    "mrzMidName": null,
    "mrzLastName": null,
    "mrzCheckSum": null,
    "mrzCode": null,
    "mrzBirthDate": null,
    "mrzNationality": null,
    "mrzSex": null,
    "mrzIssueDate": null
    }
}