Проверка по базе номинальных директоров¶

checkNominalChiefs¶

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

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

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

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

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
inn	String	Нет	ИНН физического лица
lastName	String	Нет	Фамилия
firstName	String	Нет	Имя
midName	String	Нет	Отчество

Требуется хотя бы один из параметров: inn либо lastName + firstName.

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
list	Array	Нет	Массив данных о номинальном директоре, подробнее см. данные о номинальном директоре
found	Boolean	Нет	True – человек найден в реестре номинальных директоров, False – не найден

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

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "inn": "123456789012",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович"

}

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

{
    "resultCode": 0,
    "resultMessage": " ",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "list": [*Данные о номинальном директоре*]
    "found": true
}

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

{
    "resultCode": 0,
    "resultMessage": " ",
    "operationToken": "f9fc7f5c1e0c4cb4bb9e13e57fc35ef2",
    "list": [],
    "found": false
}

Данные о номинальном директоре¶

Это объект, содержащий следующие атрибуты:

Атрибут	Тип	Описание
inn	String	ИНН номинального директора
lastName	String	Фамилия номинального директора
firstName	String	Имя номинального директора
midName	String	Отчество номинального директора
totalCount	Integer	Количество компаний, где лицо является номинальным директором

Пример объекта "Данные о номинальном директоре" в формате json:

{
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": “Иванович”,
    "inn": “123456789012”,
    "totalCount": 10
}