Гарантированное распознавание адреса прописки, задействованы верификаторы

parseAsync/passportRegistration

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

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

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

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

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

Параметры:

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

[File data]
------

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

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

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

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

{
        "resultCode": 0,
        "resultMessage": " ",
        "operationToken": “82e9d47328947457353543565349”,
        "items": [*Поле типа документа и объектов полей страницы регистрации*]
}

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

{
        "resultCode": -27,
        "resultMessage": "Некорректное изображение",
        "operationToken": "82e9d47328947457353543565349",
}

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

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

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

Пример объекта "Поле типа документа и объектов полей страницы регистрации" в формате json:

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

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

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

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

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

Атрибут	Тип	Описание
address	Field	Адрес регистрации
passportNumber	Field	Серия и номер паспорта

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

{
    "docType": "rus_passport_global_2014_main",
    "fields": {
        "address": {
            "text": ".......",
            "confidence": 0.9575766324996948
        },
        "passportNumber": {
            "text": ".......",
            "confidence": 0.9999999999999999
        }
    }
}