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

parseAuto/multiple/passportKirghizia

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/passportKirghizia 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	Дата рождения
firstName	Field	Имя
lastName	Field	Фамилия
nationality	Field	Национальность
sex	Field	Пол
midName	Field	Отчество
expiryDate	Field	Дата истечение срока
issueDate	Field	Дата выдачи
issuer	Field	Кем выдан
number	Field	Номер паспорта
docNumber	Field	Номер документа
birthPlace	Field	Место рождения
personalNumber	Field	Персональный номер(ID)

Примеры ответов с разными образцами документа Киргизского паспорта

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

{
        "docType": "kgz_passport_main",
        "fields": {
            "birthDate": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "expiryDate": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "issueDate": {
                "text": "11.11.1989",
                "confidence": 0.5898985862731934
            },
            "issuer": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9643449187278748
            },
            "nationality": {
                "text": "киргиз",
                "confidence": 0.9643449187278748
            },
            "number": {
                "text": "...",
                "confidence": 0.9991969466209412
            },
            "personalNumber": {
                "text": "123456789",
                "confidence": 0.9991969466209412
            },
            "birthPlace": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "sex": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

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

    {
        "docType": "kgz_passport_plastic_blue",
        "fields": {
            "birthDate": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "expiryDate": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "docNumber": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "firstName": {
                "text": "11.11.1989",
                "confidence": 0.5898985862731934
            },
            "nationality": {
                "text": "киргиз",
                "confidence": 0.9643449187278748
            },
            "midName": {
                "text": "...",
                "confidence": 0.9991969466209412
            },
            "sex": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

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

{
        "docType": "kgz_passport_plastic_red",
        "fields": {
            "birthDate": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "docNumber": {
                "text": "11.11.1989",
                "confidence": 0.5898985862731934
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "nationality": {
                "text": "киргиз",
                "confidence": 0.9643449187278748
            },
            "midName": {
                "text": "...",
                "confidence": 0.9991969466209412
            },
            "personalNumber": {
                "text": "123456789",
                "confidence": 0.9991969466209412
            },
            "birthPlace": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "sex": {
                "text": "...",
                "confidence": 0.9983574151992798
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}