Распознавание ВУ¶

parseAuto/multiple/driverLicense¶

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

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

Параметры:

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

[File data]
------

Пример успешного ответа:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "42280748eeed42048339ec97fecfdcce",
    "items": [*Поле типа документа и объектов полей водительского удостоверения*]
}

Пример неуспешного ответа:

{
    "resultCode": -25,
    "resultMessage": "Источник не доступен. Рекомендуем повторить запрос через 5 минут."
}

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

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

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

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

{
    "docType": "...",
    "fields": [*поля считанные с водительского удостоверения*]
}

Поля считанные с водительского удостоверения¶

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

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

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

Атрибут	Тип	Описание
lastName	Field	Фамилия
birthDate	Field	Дата рождения
firstName	Field	Имя
category	Field	Категория
validBefore	Field	Дата, до которой документ действителен
issueDate	Field	Дата выдачи
issuer	Field	Выдавший орган
birthPlace	Field	Место рождения
midName	Field	Отчество
lastNameEng	Field	Фамилия (eng)
licenseNumber	Field	Номер водительского удостоверения
placeOfIssue	Field	Место выдачи
placeOfIssueEng	Field	Место выдачи (eng)
issuerEng	Field	Выдавший орган (eng)
birthPlaceEng	Field	Место рождения (eng)
number	Field	Номер
special	Field	Дополнительно
seriesTop	Field	Серия на лицевой стороне
numberTop	Field	Номер на лицевой стороне
seriesBottom	Field	Серия на обратной стороне
numberBottom	Field	Номер на обратной стороне
docNumber	Field	Номер документа
docSeries	Field	Серия документа
firstNameEng	Field	Имя (eng)
residencyEng	Field	Место жительства (eng)
residency	Field	Место жительства
specialMarks	Field	Специальная отметка
seriesNumber	Field	Серия и номер
categoryA	Field	Категория А
categoryB	Field	Категория Б
categoryC	Field	Категория С
categoryD	Field	Категория Д
categoryE	Field	Категория Е
categoryA1Begin	Field	Категория А1 выдача
categoryA1End	Field	Категория А1 конец
categoryB1Begin	Field	Категория Б1 выдача
categoryB1End	Field	Категория Б1 окончание
categoryC1Begin	Field	Категория С1 выдача
categoryC1End	Field	Категория С1 окончание
categoryC1eBegin	Field	Категория СЕ1 выдача
categoryC1eEnd	Field	Категория СЕ1 окончание
categoryD1Begin	Field	Категория Д1 выдача
categoryD1End	Field	Категория Д1 окончание
categoryD1eBegin	Field	Категория ДЕ1 выдача
categoryD1eEnd	Field	Категория ДЕ1 окончание
categoryMBegin	Field	Категория М выдача
categoryMEnd	Field	Категория М окончание
categoryABegin	Field	Категория А выдача
categoryAEnd	Field	Категория А окончание
categoryBBegin	Field	Категория Б выдача
categoryBEnd	Field	Категория Б окончание
categoryBeBegin	Field	Категория БЕ выдача
categoryBeEnd	Field	Категория БЕ окончание
categoryCBegin	Field	Категория С выдача
categoryCEnd	Field	Категория С окончание
categoryCeBegin	Field	Категория СЕ выдача
categoryCeEnd	Field	Категория СЕ окончание
categoryDBegin	Field	Категория Д выдача
categoryDEnd	Field	Категория Д окончание
categoryDeBegin	Field	Категория ДЕ выдача
categoryDeEnd	Field	Категория ДЕ окончание
categoryTbBegin	Field	Категория тралейбус выдача
categoryTbEnd	Field	Категория тралейбус окончание
categoryTmBegin	Field	Категория трамвай выдача
categoryTmEnd	Field	Категория трамвай окончание

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

Пример ответа при отправке передней части водительского удостоверения 2011 и 2014 года образца, в виде json:¶

{
    "docType": "driver_license_2011_front",
    "fields": {
        "lastName": {
            "text": "ИВАНОВ",
            "confidence": 0.9994509220123291
        },
        "birthDate": {
            "text": "11.11.1970",
            "confidence": 0.998481810092926
        },
        "firstName": {
            "text": "ИВАН",
            "confidence": 0.9951391816139221
        },
        "category": {
            "text": "B",
            "confidence": 0.9979661107063293
        },
        "validBefore": {
            "text": "11.11.2021",
            "confidence": 0.9970619082450867
        },
        "issueDate": {
            "text": "11.11.2011",
            "confidence": 0.9957194924354553
        },
        "issuer": {
            "text": "ГИБДД 1111",
            "confidence": 0.995261549949646
        },
        "birthPlace": {
            "text": "Г. МОСКВА",
            "confidence": 0.8930715918540955
        },
        "midName": {
            "text": "ИВАНОВИЧ",
            "confidence": 0.9951391816139221
        },
        "lastNameEng": null,
        "licenseNumber": null,
        "placeOfIssue": {
            "text": "Г. МОСКВА",
            "confidence": 0.8839307427406311
        },
        "placeOfIssueEng": null,
        "issuerEng": null,
        "birthPlaceEng": null,
        "number": {
            "text": "1111111111",
            "confidence": 0.9747316241264343
        },
        "special": null
    }
}

Пример ответа при отправке передней части бумажного водительского удостоверения 1999 года образца, в виде json:¶

{
    "docType": "driver_license_1999_paper_front",
    "fields": {
        "lastName": {
            "text": "...",
            "confidence": 0.5
        },
        "birthDate": {
            "text": "...",
            "confidence": 0.5
        },
        "firstName": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesTop": {
            "text": "...",
            "confidence": 0.5
        },
        "numberTop": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesBottom": {
            "text": "...",
            "confidence": 0.5
        },
        "numberBottom": {
            "text": "...",
            "confidence": 0.5
        },
        "issueDate": {
            "text": "...",
            "confidence": 0.5
        },
        "midName": {
            "text": "...",
            "confidence": 0.5
        },
        "validBefore": {
            "text": "...",
            "confidence": 0.5
        }
    }
}

Пример ответа при отправке передней части пластикого водительского удостоверения 1999 года образца, в виде json:¶

{
    "docType": "driver_license_1999_plastic_front",
    "fields": {
        "lastName": {
            "text": "...",
            "confidence": 0.5
        },
        "birthDate": {
            "text": "...",
            "confidence": 0.5
        },
        "firstName": {
            "text": "...",
            "confidence": 0.5
        },
        "category": {
            "text": "...",
            "confidence": 0.5
        },
        "validBefore": {
            "text": "...",
            "confidence": 0.5
        },
        "issueDate": {
            "text": "...",
            "confidence": 0.5
        },
        "issuer": {
            "text": "...",
            "confidence": 0.5
        },
        "birthPlace": {
            "text": "...",
            "confidence": 0.5
        },
        "midName": {
            "text": "...",
            "confidence": 0.5
        },
        "docNumber": {
            "text": "...",
            "confidence": 0.5
        },
        "docSeries": {
            "text": "...",
            "confidence": 0.5
        },
        "firstNameEng": {
            "text": "...",
            "confidence": 0.5
        },
        "birthPlaceEng": {
            "text": "...",
            "confidence": 0.5
        },
        "residencyEng": null,
        "residency": {
            "text": "...",
            "confidence": 0.5
        },
        "special": {
            "text": "...",
            "confidence": 0.5
        },
        "lastNameEng": null
    }
}

Пример ответа при отправке обратной части бумажного водительского удостоверения 1999 года образца , в виде json:¶

{
    "docType": "driver_license_1999_paper_back",
    "fields": {
        "categoryA": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryB": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryC": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryD": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryE": {
            "text": "...",
            "confidence": 0.5
        },
        "specialMarks": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesTop": {
            "text": "...",
            "confidence": 0.5
        },
        "numberTop": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesBottom": null,
        "numberBottom": null
    }
}

Пример ответа при отправке обратной части пластикого водительского удостоверения 2011 года образца, в виде json:¶

{
    "docType": "driver_license_2011_back",
    "fields": {
        "categoryABegin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryAEnd": null,
        "categoryBBegin": null,
        "categoryBEnd": null,
        "categoryBeBegin": null,
        "categoryBeEnd": null,
        "categoryCBegin": null,
        "categoryCEnd": null,
        "categoryCeBegin": null,
        "categoryCeEnd": null,
        "categoryDBegin": null,
        "categoryDEnd": null,
        "categoryDeBegin": null,
        "categoryDeEnd": null,
        "categoryTbBegin": null,
        "categoryTbEnd": null,
        "categoryTmBegin": null,
        "categoryTmEnd": null,
        "specialMarks": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesNumber":  {
            "text": "...",
            "confidence": 0.5
        }
    }
}

Пример ответа при отправке обратной части пластикого водительского удостоверения 2014 года образца, в виде json:¶

{
    "docType": "driver_license_2014_back",
    "fields": {
        "categoryABegin": null,
        "categoryAEnd": null,
        "categoryBBegin": null,
        "categoryBEnd": null,
        "categoryBeBegin": null,
        "categoryBeEnd": null,
        "categoryCBegin": null,
        "categoryCEnd": null,
        "categoryCeBegin": null,
        "categoryCeEnd": null,
        "categoryDBegin": null,
        "categoryDEnd": null,
        "categoryDeBegin": null,
        "categoryDeEnd": null,
        "categoryTbBegin": null,
        "categoryTbEnd": null,
        "categoryTmBegin": null,
        "categoryTmEnd": null,
        "specialMarks": {
            "text": "...",
            "confidence": 0.5
        },
        "seriesNumber": null,
        "categoryA1Begin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryA1End": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryB1Begin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryB1End": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryC1Begin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryC1End": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryC1eBegin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryC1eEnd": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryD1Begin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryD1End": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryD1eBegin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryD1eEnd": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryMBegin": {
            "text": "...",
            "confidence": 0.5
        },
        "categoryMEnd": {
            "text": "...",
            "confidence": 0.5
        }
    }
}