Гарантированное распознавание основных полей страницы регистрации

/parseAsync/passportRegistrationAlter

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

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/passportRegistrationAlter
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="passportregistration.jpg"
Content-Type: image/jpeg

[File data]
------

Пример ответа на асинхронный запрос:

{
    "resultCode": 0,
    "operationToken": "82e9d47328947457353543565349",
    "resultMessage": " "
}

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

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

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

Параметр	Тип	Описание
registrationDate	String	Дата регистрации
address	String	Адрес
passportNumber	String	Серия и номер паспорта

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

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

{
    "resultCode": 0,
    "resultMessage": "...",
    "operationToken": "...",
    "taskFinished": true,
    "fields": {
        "registrationDate": "...",
        "address": "...",
        "passportNumber": "..."
    }
}

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

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