Распознавание свидетельства о рождении

parseAuto/multiple/birthCertificate

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

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

Параметры:

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

[File data]
------

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "6933bb2410b74a91bd1cfe8536af4a33",
    "items": [*поле типа документа и объекты полей свидетельства о рождении*]
}

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

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

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

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

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

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

{
    "docType": "birth_certificate",
    "fields": [*Поля считанные с свидетельства о рождении*]
}

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

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

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

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

Атрибут	Тип	Описание
recordNumber	Field	№ записи акта
birthDate	Field	Дата рождения
birthPlace	Field	Место рождения
docNumber	Field	Номер документа
motherLastName	Field	Фамилия матери
motherFirstName	Field	Имя матери
motherMidName	Field	Отчество матери
fatherLastName	Field	Фамилия отца
fatherFirstName	Field	Имя отца
fatherMidName	Field	Отчество отца
bornLastName	Field	Фамилия родившегося
bornFirstName	Field	Имя родившегося
bornMidName	Field	Отчество родившегося

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

{
    "recordNumber": {
        "text": "961",
        "confidence": 0.9963644742965698
    },
    "birthDate": {
        "text": "09.06.2014",
        "confidence": 0.9952632784843445
    },
    "birthPlace": {
        "text": "Г МОСКВА, УЛ 1-Я ИВАНОВСКАЯ",
        "confidence": 0.9941767597198486
    },
    "docNumber": {
        "text": "759381",
        "confidence": 0.9996181726455688
    },
    "motherLastName": {
        "text": "ИВАНОВА",
        "confidence": 0.9922857701778412
    },
    "motherFirstName": {
        "text": "ИННА",
        "confidence": 0.9922857701778412
    },
    "motherMidName": {
        "text": "ИВАНОВНА",
        "confidence": 0.9922857701778412
    },
    "fatherLastName": {
        "text": "ИВАНОВ",
        "confidence": 0.9950548505783081
    },
    "fatherFirstName": {
        "text": "СТЕПАН",
        "confidence": 0.9922857701778412
    },
    "fatherMidName": {
        "text": "ИВАНОВИЧ",
        "confidence": 0.9922857701778412
    },
    "bornLastName": {
        "text": "ИВАНОВ",
        "confidence": 0.9984660148620605
    },
    "bornFirstName": {
        "text": "ИВАН",
        "confidence": 0.9922857701778412
    },
    "bornMidName": {
        "text": "СТЕПАНОВИЧ",
        "confidence": 0.9922857701778412
    }
}