Проверка в реестре банкротов¶
checkBankruptOrg¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/checkBankruptOrg
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| orgName | String | Нет | Наименование организации |
| code | String | Нет | Один из двух параметров: ИНН, ОГРН |
Требуется один из параметров: либо orgName, либо code.
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| totalCount | Int | Нет | Количество найденных в ЕФРСБ записей с такими данными |
| records | Массив объектов типа record | Нет | Массив объектов – записей из ЕФРСБ. Подробнее см. записи ЕФРСБ |
Пример вызова:
POST /idx/api2/checkBankruptOrg
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"orgName": "Рога и копыта",
"code": "1234567890"
}
Пример успешного ответа:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"totalCount": 1,
"records": [*записи ЕФРСБ*]
}
Пример успешного ответа, если данные не найдены:
{
"resultCode": -100,
"resultMessage": "Информация не найдена"
}
Записи ЕФРСБ¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| category | String | Категория организации |
| debtor | String | Наименование компании |
| inn | String | ИНН компании |
| ogrn | String | ОГРН компании |
| region | String | Регион нахождения компании |
| address | String | Адрес компании |
Пример объекта "запись в ЕФРСБ" в формате json:
{
"category": "Обычная организация",
"debtor": "ООО "Рога и копыта"",
"inn": "1234567890",
"ogrn": "1234567890123",
"region": "г. Москва",
"address": "Москва, ул. Московская, д. 1, помещение 1"
}