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

parseAuto/multiple/inn

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

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

Параметры:

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

[File data]
------

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

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

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

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

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

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

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

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

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

Поля считанные со свидетельства ИНН

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

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

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

Атрибут	Тип	Описание
inn	Field	ИНН
name	Field	ФИО
series	Field	Серия документа
number	Field	Номер документа
issueDate	Field	Дата выдачи
issuerNumber	Field	Номер налогового органа

Пример успешного ответа, при отправке свидетельства ИНН в виде json:

{
    "docType": "inn_person",
    "fields": {
        "inn": {
            "text": "123456789012",
            "confidence": 0.3220444321632385
        },
        "name": {
            "text": "ИВАНОВ ИВАН ИВАНЫЧ",
            "confidence": 0.9806541204452515
        },
        "series": {
            "text": "1234",
            "confidence": 0.7524929046630859
        },
        "number": {
            "text": "123456",
            "confidence": 0.8185754418373108
        },
        "issueDate": {
            "text": "01.01.2000",
            "confidence": 0.9794724583625793
        },
        "issuerNumber": {
            "text": "1111",
            "confidence": 0.944671630859375
        }
    }
}