Проверка по санкционным спискам физических лиц

checkIndividualSanction

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

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

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

• 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 – успешное завершение функции, -100 - данные не найдены, другое значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
list	Array	Нет	Массив данных о лицах, находящихся под санкциями, подробнее см. данные о лице, находящихся под санкциями
found	Boolean	Нет	True – человек найден в санкционных списках, False – не найден

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

POST /idx/api2/checkIndividualSanction
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
}

Данные о лице, находящемся под санкциями

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

Атрибут	Тип	Описание
name	String	Полное имя лица
nameEng	String	Полное имя на английском языке
birthDate	String	Дата рождения
isActive	Boolean	Признак
startDate	String	Дата начала применения санкций
endDate	String	Дата окончания применения санкций
additionalInfo	String	Дополнительная информация
activeSanctions	String	Список санкционных ограничений
source	String	Источник санкций

Пример объекта "Данные о лице, находящемся под санкциями" в формате json:

{
    "name": "Иванов Иван Иванович",
    "nameEng": "Ivanov Ivan Ivanovich",
    "birthDate": "1983-01-01",
    "isActive": true,
    "startDate": "01.01.2023",
    "endDate": "01.01.2032",
    "additionalInfo": "",
    "activeSanctions": "блокировка активов",
    "source": "Украина"
}