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

parseAuto/multiple/passportKazakh

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
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/passportKazakh 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	Фамилия
midName	Field	Отчество
expiryDate	Field	Дата истечение срока
issueDate	Field	Дата выдачи
issuer	Field	Кем выдан
nationality	Field	Национальность
number	Field	Номер паспорта
docNumber	Field	Номер документа
birthPlace	Field	Место рождения
personalid	Field	Персональный индентификатор
inn	Field	ИНН
mrz	Field	МРЗ

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

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

{
        "docType": "kz_id_1994_back",
        "fields": {
            "address": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "barcode": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "expiryDate": {
                "text": "19.12.2048",
                "confidence": 0.5898985862731934
            },
            "issueDate": {
                "text": "31.08.2005",
                "confidence": 0.9915384650230408
            },
            "issuer": {
                "text": "МИНИСТЕРСТВО ЮСТИЦИИ",
                "confidence": 0.9643449187278748
            },
            "nationality": {
                "text": "казах",
                "confidence": 0.9643449187278748
            },
            "number": {
                "text": "1000",
                "confidence": 0.9991969466209412
            },
            "birthPlace": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

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

    {
        "docType": "kz_id_1994_front",
        "fields": {
            "birthPlace": {
                "text": "...",
                "confidence": 0.9970301389694214
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "midName": {
                "text": "19.12.2048",
                "confidence": 0.5898985862731934
            },
            "personalId": {
                "text": "31.08.2005",
                "confidence": 0.9915384650230408
            },
            "lastName": {
                "text": "МИНИСТЕРСТВО ЮСТИЦИИ",
                "confidence": 0.9643449187278748
            }
        }
    }
}

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

{
        "docType": "kz_id_2008_back",
        "fields": {
            "birthDate": {
                "text": "20.09.2007",
                "confidence": 0.9970301389694214
            },
            "inn": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "firstName": {
                "text": "...",
                "confidence": 0.5898985862731934
            },
            "midName": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9643449187278748
            }
        }
    }
}

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

{
        "docType": "kz_id_2008_front",
        "fields": {
            "expiryDate": {
                "text": "19.12.2048",
                "confidence": 0.9970301389694214
            },
            "issueDate": {
                "text": "20.09.2007",
                "confidence": 0.9765521287918091
            },
            "docNumber": {
                "text": "123456789",
                "confidence": 0.5898985862731934
            },
            "issuer": {
                "text": "...",
                "confidence": 0.9915384650230408
            },
            "mrz": {
                "text": "....",
                "confidence": 0.9643449187278748
            },
            "nationality": {
                "text": "казах",
                "confidence": 0.9643449187278748
            }
            "birthPlace": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

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

   {
        "docType": "kz_id_2014_back",
        "fields": {
            "expiryDate": {
                "text": "19.12.2048",
                "confidence": 0.9970301389694214
            },
            "issueDate": {
                "text": "20.09.2007",
                "confidence": 0.9765521287918091
            },
            "issuer": {
                "text": "123456789",
                "confidence": 0.5898985862731934
            },
            "nationality": {
                "text": "казах",
                "confidence": 0.9643449187278748
            },
            "number": {
                "text": "123456789",
                "confidence": 0.9643449187278748
            }
            "birthPlace": {
                "text": "...",
                "confidence": 0.9983574151992798
            }
        }
    }
}

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

   {
        "docType": "kz_id_2014_front",
        "fields": {
            "birthDate": {
                "text": "08.04.1977",
                "confidence": 0.9970301389694214
            },
            "firstName": {
                "text": "...",
                "confidence": 0.9765521287918091
            },
            "midName": {
                "text": "...",
                "confidence": 0.5898985862731934
            },
            "personalId": {
                "text": "...",
                "confidence": 0.9643449187278748
            },
            "lastName": {
                "text": "...",
                "confidence": 0.9643449187278748
            }
        }
    }
}