Проверка по реестру иностранных агентов

checkForeignAgent

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

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

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

• 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	Нет	Отчество
inn	String	Нет	ИНН
snils	String	Нет	СНИЛС

Требуется Фамилия+Имя+Отчество, либо Фамилия+Имя, либо Фамилия, либо СНИЛС, либо ИНН.

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

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

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

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

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

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

{
    "resultCode": 0,
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "list": [*Данные об иностранном агенте*]
    "found": true
}

Пример успешного ответа, если данные не найдены:

{
    "resultCode": -100,
    "operationToken": "f9fc7f5c1e0c4cb4bb9e13e57fc35ef2",
    "list": [],
    "found": false
}

Данные об иностранном агенте

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

Атрибут	Тип	Описание
fullName	String	Полное имя
birthDate	String	Дата рождения
inn	String	ИНН
snils	String	СНИЛС
inclusionDecisionDate	String	Дата включения в реестр
exclusionDecisionDate	String	Дата исключения из реестра

Пример объекта "Данные об иностранном агенте" в формате json:

{
    "fullName": "Иванов Иван Иванович",
    "birthDate": "01.01.1950",
    "inn": "123456789012",
    "snils": "12345678901",
    "inclusionDecisionDate": "01.01.2024",
    "exclusionDecisionDate": ""
}