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

parseAuto/multiple/passportTajikistan

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/passportTajikistan 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	Дата рождения
expiryDate	Field	Дата истечение срока
issueDate	Field	Дата выдачи
firstName	Field	Имя
nationality	Field	Национальность
number	Field	Номер паспорта
sex	Field	Пол
lastName	Field	Фамилия

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

{
        "docType": "tjk_passport_main",
        "fields": {
            "birthDate": {
                "text": "09.12.1995",
                "confidence": 0.9765521287918091
            },
            "expiryDate": {
                "text": "15.07.2029",
                "confidence": 0.5898985862731934
            },
            "issueDate": {
                "text": "15.07.2030",
                "confidence": 0.9915384650230408
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "nationality": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "number": {
                "text": "AA11111111",
                "confidence": 0.9915384650230408
            },
            "sex": {
                "text": "M",
                "confidence": 0.9983574151992798
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9915384650230408
            }
        }
    }
}