Распознавание свидетельства о заключении брака

parseAuto/multiple/marriageСertificate

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

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

Параметры:

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

[File data]
------

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

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

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

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

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

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

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

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

{
    "docType": "marriage_certificate",
    "fields": [*Поля считанные с свидетельства о заключении брака*]
}

Поля считанные с свидетельства о заключении брака

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

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

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

Атрибут	Тип	Описание
recordNumber	Field	№ записи акта
marriageDate	Field	Дата заключения брака
husbandBirthDate	Field	Дата рождения супруга
wifeBirthDate	Field	Дата рождения супруги
docNumber	Field	Номер документа
docSeries	Field	Серия документа
husbandLastName	Field	Фамилия мужа
husbandFirstName	Field	Имя мужа
husbandMidName	Field	Отчество мужа
husbandLastNameAfter	Field	Фамилия мужа после заключения брака
wifeLastName	Field	Фамилия жены
wifeFirstName	Field	Имя жены
wifeMidName	Field	Отчество жены
wifeLastNameAfter	Field	Фамилия жены после заключения брака
husbandEthnicity	Field	Этничность супруга
husbandNationality	Field	Национальность супруга
husbandPlaceOfBirth	Field	Место рождения супруга
issuingAuthorityHead	Field	Руководитель органа выдачи
issuingAuthority	Field	Место государственной регистрации
reissuedRequest	Field	Повторный запрос
wifeEthnicity	Field	Этничность супруги
wifeNationality	Field	Национальность супруги
wifePlaceOfBirth	Field	Место рождения супруги
dateOfMarriageText	Field	Текстовое описание даты заключения брака
dateOfAct	Field	Дата акта
placeOfRegistration	Field	Место регистрации
dateOfIssue	Field	Дата выдачи

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

{
    "recordNumber": {
        "text": "1234",
        "confidence": 0.9941891431808472
    },
    "marriageDate": {
        "text": "",
        "confidence": 0.0
    },
    "husbandBirthDate": {
        "text": "01.01.2001",
        "confidence": 0.9985032081604004
    },
    "wifeBirthDate": {
        "text": "02.02.2002",
        "confidence": 0.9979835748672485
    },
    "docNumber": {
        "text": "1234",
        "confidence": 1.0
    },
    "husbandLastName": {
        "text": "ТЕСТОВ",
        "confidence": 0.9990239143371582
    },
    "husbandFirstName": {
        "text": "ОЛЕГ",
        "confidence": 0.9896442890167236
    },
    "husbandMidName": {
        "text": "ТЕСТОВИЧ",
        "confidence": 0.9896442890167236
    },
    "wifeLastName": {
        "text": "ТЕСТОВА",
        "confidence": 0.9971844553947449
    },
    "wifeFirstName": {
        "text": "ДАРЬЯ",
        "confidence": 0.9941938519477844
    },
    "wifeMidName": {
        "text": "ТЕСТОВНА",
        "confidence": 0.9941938519477844
    },
    "husbandLastNameAfter": {
        "text": "ТЕСТОВ",
        "confidence": 0.9995681643486023
    },
    "wifeLastNameAfter": {
        "text": "ТЕСТОВАЯ",
        "confidence": 0.9997871518135071
    },
    "husbandEthnicity": {
        "text": "РУССКИЙ",
        "confidence": 0.9996939897537231
    },
    "husbandNationality": {
        "text": "ГРАЖДАНИН РОССИИ",
        "confidence": 0.9852622151374817
    },
    "husbandPlaceOfBirth": {
        "text": "Г. ГОРОД,ГОРОДСКАЯ ОБЛАСТЬ",
        "confidence": 0.6389223337173462
    },
    "issuingAuthorityHead": {
        "text": "Т.С.ТЕСТОВА",
        "confidence": 0.9932859539985657
    },
    "issuingAuthority": {
        "text": "ДВОРЕЦ ТОРЖЕСТВЕННЫХ ОБРЯДОВ №",
        "confidence": 0.17118264734745026
    },
    "reissuedRequest": {
        "text": "",
        "confidence": 1.0
    },
    "wifeEthnicity": {
        "text": "--------",
        "confidence": 0.9039183259010315
    },
    "wifeNationality": {
        "text": "ГРАЖДАНКА РОССИИ",
        "confidence": 0.9892337322235107
    },
    "wifePlaceOfBirth": {
        "text": "Г.ТЕСТОВЫЙ,ТЕСТОВАЯ ОБЛАСТЬ",
        "confidence": 0.9628815650939941
    },
    "dateOfMarriageText": {
        "text": "ПЯТОГО ОКТЯБРЯ ДВЕ ТЫСЯЧИ ДВАДЦАТЬ ЧЕТВЕРТОГО ГОДА",
        "confidence": 0.9698338508605957
    },
    "dateOfAct": {
        "text": "05.11.2024",
        "confidence": 0.9991175532341003
    },
    "placeOfRegistration": {
        "text": "",
        "confidence": 1.0
    },
    "dateOfIssue": {
        "text": "05.10.2024",
        "confidence": 0.9992283582687378
    }
}