Skip to content

Проверка в реестре контролируемых лиц МВД

checkRkl

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

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

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

  • JSON, Content-Type: application/json

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

Параметры:

Параметр Тип Обязательный Описание
accessKey String Да Ключ доступа, выданный при регистрации в Системе IDX
secretKey String Да Секретный ключ, выданный при регистрации в Системе IDX
fullName String Да Фамилия, имя и отчество (при наличии) проверяемого лица
birthDate String Да Дата рождения в формате ДД.ММ.ГГГГ
docNumber String Да Серия и номер документа, удостоверяющего личность
passportDate String Да Дата выдачи документа, удостоверяющего личность

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

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

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

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "fullName": "ИВАНОВ ИВАН",
    "birthDate": "10.01.1980",
    "docNumber": "XX12345678",
    "passportDate": "01.10.2010"
}

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

{
    "resultCode": 0,
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "found": true
}

Пример ответа, если проверяемое лицо не найдено в реестре контролируемых лиц:

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