Скоринг предбанкротства

getBankruptcyPrediction

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

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

Поддерживаются следующие форматы передачи параметров:

• JSON, Content-Type: application/json

• Form submit, Content-Type: application/x-www-form-urlencoded

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
ogrn	String	Нет	ОГРН ЮЛ
inn	String	Нет	ИНН ЮЛ

Требуется один из параметров: либо ogrn, либо inn. Поиск по ogrn более желателен

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
score	Double	Нет	Оценка вероятности банкротства. Значение от 0 до 1. Чем ближе к 1, тем больше вероятность банкротства. Компании у которых Score > 0.5 считаются потенциальными банкротам в ближайшем будущем
probability	String	Нет	Оценка вероятности банкротства в текстовом виде
estimationDate	String	Нет	Дата на которую проводилась оценка

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

POST /idx/api2/getBankruptcyPrediction
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "ogrn": "1234567890123"
}

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "4daa01a449d44ada82990a4b979beac9",
    "score": 0.013371021,
    "probability": "Low",
    "estimationDate": "10.02.2022"
}

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

{
    "resultCode": -100,
    "resultMessage": "Информация не найдена",
    "operationToken": "4daa01a449d44ada82990a4b979beac9"
}