Проверка в реестре публичных должностных лиц¶
checkPep¶
Данный вызов недоступен в личном кабинете
Для подключения обратитесь на support@iidx.ru
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/checkPep
Поддерживаются следующие форматы передачи параметров:
-
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 | Нет | Отчество |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| pep | Boolean | Нет | Признак публичного должностного лица (true - найден в реестре, false - не найден) |
| data | Массив объектов | Нет | Массив объектов с данными о публичных должностных лицах, подробнее см. публичное должностное лицо |
Пример вызова:
POST /idx/api2/checkPep
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"lastName": "Иванов",
"firstName": "Иван",
"midName": "Иванович"
}
Пример успешного ответа:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"pep": true,
"data": [
{
"lastName": "Иванов",
"firstName": "Иван",
"midName": "Иванович",
"description": "Полномочный представитель Президента Российской Федерации в Уральском федеральном округе",
"url": "http://uralfo.gov.ru/polpred/polpred/"
}
]
}
Публичное должностное лицо¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| lastName | String | Фамилия публичного должностного лица |
| firstName | String | Имя |
| midName | String | Отчество |
| description | String | Краткое описание деятельности |
| url | String | Ссылка на источник информации |