Распознавание СНИЛС

parseAuto/multiple/snils

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

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

Параметры:

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

[File data]
------

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "057103b184754dd9ac6e4b28cb34cb40",
    "items": [*поле типа документа и объекты полей СНИЛС*]
}

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

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

Поле типа документа и объектов полей СНИЛС

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

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

Пример объекта "Поля считанные с СНИЛС" в формате json:

{
    "docType": "...",
    "fields": [*поля считанные с СНИЛС*]
}

Поля считанные с СНИЛС

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

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

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

Атрибут	Тип	Описание
dayOfBirth	Field	День рождения
monthOfBirth	Field	Месяц рождения
firstName	Fieldт	Имя
number	Field	Номер СНИЛС
placeOfBirth	Field	Место рождения
sex	Field	Пол
lastName	Field	Фамилия
midName	Field	Отчество
yearOfBirth	Field	Год рождения
issueDay	Field	День выдачи
issueMonth	Field	Месяц выдачи
issueYear	Field	Год выдачи

Пример объекта "Поля считанные с СНИЛС" в формате json:

{
    "dayOfBirth": {
        "text": "1",
        "confidence": 0.9962769150733948
    },
    "monthOfBirth": {
        "text": "ДЕКАБРЯ",
        "confidence": 0.9980582594871521
    },
    "firstName": {
        "text": "ИВАН",
        "confidence": 0.9719521403312683
    },
    "number": {
        "text": "123-456-789 01",
        "confidence": 0.9896863102912903
    },
    "placeOfBirth": {
        "text": "ИВАНОВО КРАСНОЯРСКИЙ КРАЙ",
        "confidence": 0.916740894317627
    },
    "sex": {
        "text": "МУЖСКОЙ",
        "confidence": 0.9932765960693359
    },
    "lastName": {
        "text": "ИВАНОВ",
        "confidence": 0.9945114850997925
    },
    "midName": {
        "text": "ИВАНОВИЧ",
        "confidence": 0.9968749284744263
    },
    "yearOfBirth": {
        "text": "1990",
        "confidence": 0.9942313432693481
    },
    "issueDay": {
        "text": "11",
        "confidence": 0.9951509237289429
    },
    "issueMonth": {
        "text": "ДЕКАБРЯ",
        "confidence": 0.99472975730896
    },
    "issueYear": {
        "text": "2007",
        "confidence": 0.9970031380653381
    }
}