Skip to content

Проверка залогов

checkRz

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

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

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

  • 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 Да Отчество
birthDate String Да Дата рождения в формате DD.MM.YYYY

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

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

Пример вызова (передача параметров в формате json):

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

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

Пример ответа (результаты в формате json):

{
    "resultCode": 0,
    "operationToken": "f8a41353058b4c92b5fbcd18e9aef3b8",
    "startMoment": "01.12.2017 11:20:59",
    "stopMoment": "01.12.2017 11:22:17",
    "found": true,
    "data": [*Уведомление о залоге*]
}

Уведомление о залоге

Объект «Уведомление о залоге» включает следующие атрибуты:

Атрибут Тип Описание
registerDate String Дата регистрации
referenceNumber String Номер уведомления о возникновении залога
properties[] Массив описаний имущества:
properties[]/prefix String Код (VIN, ID)
properties[]/value String Значение
pledgors[] Массив залогодателей:
pledgors[]/name String ФИО залогодателя
pledgors[]/birth String Дата рождения залогодателя
pledgees Массив залогодержателей:
pledgees[]/name String ФИО залогодержателя
pledgees[]/birth String Дата рождения залогодержателя
history Array Массив объектов с историей измениния состояния залога движимого имущества, подробнее см. история изменения состояния залога

Пример объекта «Уведомление о залоге» в формате json:

    {
        "registerDate": "01.03.2020",
        "referenceNumber": "2020-000-110000-110",
        "properties": [
            {
                "prefix": "VIN",
                "value": "12345678901234567"
            }
        ],
        "pledgors": [
            {
                "name": "Иванов Иван Иванович",
                "birth": "01.01.1970"
            }
        ],
        "pledgees": [
            {
                "name": "Открытое акционерное общество \"Рога и копыта\"",
            }
        ],
        "history": [
            {
                "date": "01.03.2020",
                "type": "Возникновение",
                "number": "2020-000-110000-110"
            }
        ]
    }

История изменения состояния залога

Объект «История изменения состояния залога» включает следующие атрибуты:

Атрибут Тип Описание
date String Дата изменения состояния залога
type String Вид изменения состояния (возникновение, прекращение и т.д.)
number String Регистрационный номер