Автоматическое гарантированное распознавание документа Вида на жительство¶

/parseAsync/parseResidencePermit¶

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

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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	Нет	Статус проверки
explained	Объект типа Explained	Нет	Массив распознанных документов Подробнее см. Поле распознынных документов

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

POST /idx/api2/parseAsync/parseResidencePermit
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="residencePermit.jpg"
Content-Type: image/jpeg

[File data]
------

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

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

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

Поле распознынных документов¶

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

Параметр	Тип	Описание
residencePermit	Объект типа ResidencePermit	Объект содержащий в себе документ Вид на жительство Подробнее см. Поле документа Вид на жительство

Поле документа Вид на жительство¶

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

Параметр	Тип	Описание
present	Bool	Предоставлен ли документ Вид на жительство
pages	Объект типа Pages	Объект содержащий в себе распознанные поля документа Вид на жительство Подробнее см. Поля считанные с Вида на жительство

Поля считанные с Вида на жительство¶

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

Параметр	Тип	Описание
issuer	String	Кем выдан
number	String	Номер
series	String	Серия
fullName	String	Полное имя
firstName	String	Имя
lastName	String	Фамилия
midname	String	Отчество
birthDate	String	Дата рождения
issueDate	String	Дата выдачи
validDate	String	Действителен до
birthPlace	String	Место рождения

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

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

{
"explained": {      
    "residence-permit": {
        "pages": [
            {
                "issuer": "string",
                "number": "string",
                "series": "string",
                "taskId": "string",
                "fileIds": [
                    "document_0/page_0",
                    "document_0/page_1"
                ],
                "fullName": "string",
                "lastName": "string",
                "birthDate": "string",
                "firstName": "string",
                "issueDate": "string",
                "validDate": "string",
                "birthPlace": "string",
                "midname": "string"
            }
        ],
        "errors": [],
        "present": true
    }       
},
"document_0": [
    "residence-permit"
]
}

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

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