Проверка по перечню банкротов¶
checkBankruptPerson¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/checkBankruptPerson
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| lastName | String | Нет | Фамилия |
| firstName | String | Нет | Имя |
| midName | String | Нет | Отчество |
| address | String | Нет | Адрес проживания |
| code | String | Нет | Один из трех параметров: ИНН, ОГРНИП, СНИЛС |
Требуется один из наборов параметров: либо ФИО, либо code. Чем больше параметров указано, тем точнее будет поиск
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| totalCount | Int | Нет | Количество найденных в ЕФРСБ записей с такими данными |
| records | Массив объектов типа record | Нет | Массив объектов – записей из ЕФРСБ. Подробнее см. записи ЕФРСБ |
Пример вызова:
POST /idx/api2/checkBankruptPerson
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"lastName": "Иванов",
"firstName": "Иван",
"midName": "Иванович",
"address": "город Москва, улица Московская, дом 1",
"code": "11122233344",
}
Пример успешного ответа:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"totalCount": 1,
"records": [*записи ЕФРСБ*]
}
Пример успешного ответа, если данные не найдены:
{
"resultCode": -100,
"resultMessage": "Информация не найдена"
}
Записи ЕФРСБ¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| category | String | Статус должника |
| debtor | String | ФИО должника |
| inn | String | ИНН должника |
| ogrn | String | ОГРНИП должника |
| snils | String | СНИЛС должника |
| region | String | Регион проживания должника |
| address | String | Адрес проживания должника |
| birthplace | String | Место рождения должника |
| birthdate | String | Дата рождения должника |
| messages | Массив объектов типа message | Сообщения по делу о банкротстве. Подробнее см. сообщения по делу |
Пример объекта "запись в ЕФРСБ" в формате json:
{
"category": "Физическое лицо",
"debtor": "Иванов Иван Иванович",
"inn": "123456789012",
"ogrn": "",
"snils": "111-222-333 44",
"region": "г. Москва",
"address": "Москва, ул. Московская, д. 1, кв. 1",
"birthplace": "Иркутская область г. Братск",
"birthdate": "01.01.1977",
"messages": [*Сообщения по делу о банкротстве*]
}
Сообщение по делу о банкротстве¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| publicationType | String | Тип публикации (Сообщение, Отчет или Существенный факт) |
| number | String | Номер сообщения |
| date | String | Дата сообщения |
| isAnnulled | Boolean | Признак аннулирования |
| type | String | Тип сообщения |
| actType | String | Дополнительная информация о сообщении |
Пример сообщения по делу о банкротстве в формате json:
{
"publicationType": "Сообщение",
"number": "10000004",
"date": "01.10.2020",
"isAnnulled": false,
"type": "Сообщение о судебном акте",
"actType": "о завершении реализации имущества гражданина"
}