Гарантированное распознавание полей паспорта

/parseAsync/parseManualPassport

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

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

Данный метод работает исключительно в режиме асинхронного выполнения. Подробнее, см. асинхронный режим выполнения запросов

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

URL вызова: https://api.id-x.org/idx/api2/parseAsync/parseManualPassport

Параметры:

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

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

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

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
taskFinished	Boolean	Нет	Статус проверки
fields	Лист объектов типа String	Нет	Список полей, считанных со страницы паспорта поля, считанные со страницы паспорта

Пример асинхронного вызова:

POST /idx/api2/parseAsync/parseManualPassport
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,
    "operationToken": "82e9d47328947457353543565349",
    "resultMessage": " "
}

operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.

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

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

Параметр	Тип	Описание
series	String	Серия
number	String	Номер паспорта
gender	String	Пол
lastName	String	Фамилия
firstName	String	Имя
middleName	String	Отчество
birthDate	String	Дата рождения
issueDate	String	Дата выдачи
birthPlace	String	Место рождения
issuer	String	Подразделение, выдавшее паспорт
issuerCode	String	Код подразделения

Примеры ответа

Пример успешного ответа, получаемого через getAsyncResult:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "123456b071f140e090286085ff625140",
    "taskFinished": true,
    "fields": {
        "gender": "МУЖ.",
        "issuer": "ОТДЕЛОМ УФМС Г. МОСКВА",
        "number": "567890",
        "series": "1234",
        "lastName": "ИВАНОВ",
        "firstName": "ИВАН",
        "middleName": "ИВАНОВИЧ",
        "birthDate": "01.01.2000",
        "issueDate": "01.02.2020",
        "birthPlace": "ГОР. МОСКВА",
        "issuerCode": "770-001"
    }
}

Пример неуспешного ответа, получаемого через getAsyncResult:

{
    "resultCode": -100,
    "resultMessage": "Информация не найдена"
}