Автоматическое распознавание формы 2-НДФЛ

parseAuto/multiple/ndfl2

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
file	File	Да	Изображение формы 2-НДФЛ

Проверка распознает следующие форматы: JPG, JPEG, PNG, BMP, TIFF, GIF, PDF, DJVU

Фотография должна соответствовать требованиям к качеству

Функция возвращает:

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -27 – некорректное изображение, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
items	Массив типа Item	Нет	Массив объектов – поле типа документа и объектов полей 2-НДФЛ Подробнее см. поле типа документа и объектов полей 2-НДФЛ

Пример вызова:

POST /idx/api2/parseAuto/multiple/ndfl2 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="ndfl2.jpg"
Content-Type: image/jpeg

[File data]
------

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "7711a43c116147cb9996dfc67408b1da",
    "items": [*поле типа документа и объекты полей 2-НДФЛ*]
}

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

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

Поле типа документа и объектов полей 2-НДФЛ

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

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

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

{
    "docType": "...",
    "fields": [*Поля считанные с 2-НДФЛ*]
}

Поля считанные с 2-НДФЛ

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

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

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

Атрибут	Тип	Описание
agent	Field	Налоговый агент
agentInn	Field	ИНН налогового агента
bottom	Field	Общие суммы дохода и налога
dateOfBirth	Field	Дата рождения физического лица
docDate	Field	Дата выдачи справки
middle	Field	Стандартные, социальные и имущественные налоговые вычеты
firstName	Field	Имя физического лица
midName	Field	Отчество физического лица
ruInn	Field	ИНН физического лица
lastName	Field	Фамилия физического лица
topLeftTable	Field	Доходы облагаемые по ставке, первый столбец
topRightTable	Field	Доходы облагаемые по ставке, второй столбец

Пример успешного ответа, при отправке 2-НДФЛ в виде json:

{
    "docType": "ndfl2",
    "fields": {
        "agent": {
            "text": "...",
            "confidence": 0.3220444321632385
        },
        "agentInn": {
            "text": "1111111111",
            "confidence": 0.9806541204452515
        },
        "bottom": null,
        "dateOfBirth": {
            "text": "11.11.1970",
            "confidence": 0.7524929046630859
        },
        "docDate": {
            "text": "11.11.1970",
            "confidence": 0.8185754418373108
        },
        "middle": null,
        "firstName": {
            "text": "ИВАН",
            "confidence": 0.9794724583625793
        },
        "midName": {
            "text": "ИВАНОВИЧ",
            "confidence": 0.944671630859375
        },
        "ruInn": {
            "text": "1111111111",
            "confidence": 0.9945974349975586
        },
        "lastName": {
            "text": "ИВАНОВ",
            "confidence": 0.6298033595085144
        },
        "topLeftTable": null,
        "topRightTable": null
    }
}