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

parseAuto/multiple/globalPassport

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/globalPassport 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	Дата рождения
expiryDate	Field	Дата окончания
issueDate	Field	Дата выдачи
issuingAuthority	Field	Кем выдан
nameEng	Field	Имя (eng)
nameRus	Field	Имя (rus)
number	Field	Номер
series	Field	Cерия
genderEng	Field	Пол (eng)
genderRus	Field	Пол (rus)
lastNameEng	Field	Фамилия (eng)
lastNameRus	Field	Фамилия (rus)
birthplace	Field	Место рождения

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

{
    "docType": "rus_passport_global_2014_main",
    "fields": {
        "birthDate": {
            "text": "11.11.1970",
            "confidence": 0.9575766324996948
        },
        "expiryDate": {
            "text": "11.11.1970",
            "confidence": 0.9954750537872314
        },
        "issueDate": {
            "text": "11.11.1970",
            "confidence": 0.9964780211448669
        },
        "issueAuthority": {
            "text": "ФМС  11111",
            "confidence": 0.7038835287094116
        },
        "nameEng": {
            "text": "",
            "confidence": 0.0
        },
        "nameRus": {
            "text": "...",
            "confidence": 0.3143784701824188
        },
        "number": {
            "text": "0111111",
            "confidence": 0.9987398386001587
        },
        "series": {
            "text": "11",
            "confidence": 0.9981639385223389
        },
        "genderEng": {
            "text": "M",
            "confidence": 0.9996253848075867
        },
        "genderRus": {
            "text": "М",
            "confidence": 0.9928672313690186
        },
        "lastNameEng": {
            "text": "",
            "confidence": 0.0
        },
        "lastNameRus": {
            "text": "...",
            "confidence": 0.3380918800830841
        },
        "birthPlace": {
            "text": "Г. МОСКВА / USSR",
            "confidence": 0.8950963616371155
        }
    }
}