Поиск ИП в ЕГРИП. Получение основных данных¶
egrulSearch/individual¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/egrulSearch/individual
Поддерживаются следующие форматы передачи параметров:
-
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 | Нет | Код региона |
| personName | String | Нет | ФИО предпринимателя |
Требуется хотя бы один из параметров: inn, ogrn, personName.
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| rows | Array | Нет | Массив данных об индивидуальном предпринимателе, подробнее см. данные об ИП |
Пример вызова:
POST /idx/api2/egrulSearch/individual
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"inn": "ИНН индивидуального предпринимателя",
"ogrn": "ОГРН индивидуального предпринимателя",
"region": "Код региона",
"personName": "Иванов Иван Иванович"
}
Пример успешного ответа:
{
"resultCode": 0,
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"rows": {*Данные об ИП*}
}
Пример неуспешного ответа:
{
"resultCode": -100,
"resultMessage": "Ничего не найдено"
}
Данные об ИП¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| name | String | ФИО предпринимателя |
| issueDate | String | Дата присвоения ОГРН |
| ogrn | String | ОГРН индивидуального предпринимателя |
| inn | String | ИНН индивидуального предпринимателя |
| endOfActivity | String | Дата окончания активности |
Пример объекта "Данные об ИП" в формате json:
{
"name": "Иванов Иван Иванович",
"issueDate": "01.01.2010",
"ogrn": “ОГРН индивидуального предпринимателя”,
"inn": “ИНН индивидуального предпринимателя”,
"endOfActivity": “01.01.2020”
}