Поиск ЮЛ в ЕГРЮЛ. Получение основных данных¶
egrulSearch/company¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/egrulSearch/company
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| inn | String | Нет | ИНН компании |
| ogrn | String | Нет | ОГРН компании |
| region | Integer | Нет | Код региона |
| companyName | String | Нет | Название компании |
| addParams | Boolean | Нет | Признак получения расширенного ответа |
Требуется хотя бы один из параметров: inn, ogrn, companyName.
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| rows | Array | Нет | Массив данных о юридическом лице, подробнее см. данные о ЮЛ |
Пример вызова:
POST /idx/api2/egrulSearch/company
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"inn": "ИНН компании",
"ogrn": "ОГРН компании",
"region": "Код региона",
"companyName": "Название компании"
}
Пример успешного ответа:
{
"resultCode": 0,
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"rows": {*Данные о ЮЛ*}
}
Пример неуспешного ответа:
{
"resultCode": -100,
"resultMessage": "Ничего не найдено"
}
Данные о ЮЛ¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| chief | String | ФИО директора |
| issueDate | String | Дата присвоения ОГРН |
| name | String | Имя юридического лица |
| ogrn | String | ОГРН юридического лица |
| inn | String | ИНН юридического лица |
| kpp | String | КПП юридического лица |
| endOfActivity | String | Дата окончания активности |
| status | String | Должность директора (возвращается только при указании параметра addParams = true) |
| address | String | Юридический адрес (возвращается только при указании параметра addParams = true) |
Пример объекта "Данные о ЮЛ" в формате json:
{
"chief": "Генеральный директор: Иванов Иван Иванович",
"issueDate": "01.01.2010",
"name": "ООО Рога и Копыта",
"ogrn": “ОГРН юридического лица”,
"inn": “ИНН юридического лица”,
"kpp": “КПП юридического лица”,
"endOfActivity": “01.01.2020”
}
Пример расширенного объекта "Данные о ЮЛ" при указании параметра addParams = true в формате json:
{
"address": "117312, МОСКВА ГОРОД, ВАВИЛОВА УЛИЦА, 19",
"status": "ПРЕЗИДЕНТ, ПРЕДСЕДАТЕЛЬ ПРАВЛЕНИЯ",
"chief": "Иванов Иван Иванович",
"issueDate": "01.01.2010",
"name": "ООО Рога и Копыта",
"ogrn": “ОГРН юридического лица”,
"inn": “ИНН юридического лица”,
"kpp": “КПП юридического лица”,
"endOfActivity": “01.01.2020”
}