Получение полиса ОСАГО по VIN, госномеру или номеру кузова

checkOsagoV2

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

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

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

• JSON, Content-Type: application/json

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

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
vin	String	Нет	Идентификационный номер транспортного средства (VIN)
bodyNumber	String	Нет	Номер кузова
regNumber	String	Нет	Государственный регистрационный номер транспортного средства

Требуется только один из трех параметров: vin / bodyNumber / regNumber.

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
policies	Массив объектов	Нет	Массив данных о полисе ОСАГО, подробнее см. данные полиса ОСАГО

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

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "vin":  "12345678901234567"
}

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "policies": [*Данные полиса ОСАГО*]
}

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

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "policies": []
}

Данные полиса ОСАГО

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

Атрибут	Тип	Описание
companyName	String	Компания страховщик
policyNumber	String	Номер полиса
policySerial	String	Серия Полиса
vin	String	Идентификационный номер транспортного средства (VIN)
regNumber	String	Государственный регистрационный номер транспортного средства
mark	String	Марка автомобиля
model	String	Модель автомобиля
status	String	Статус полиса
startDate	String	Дата начала периода страхования
endDate	String	Дата окончания периода страхования

Пример объекта "Данные полиса ОСАГО" в формате json:

{
    "companyName": "СПАО \"Ингосстрах\"",
    "policyNumber": "0369362367",
    "policySerial": "ХХХ",
    "vin": "JF9SH9LS99G099999",
    "regNumber": "А777ВВ197",
    "mark": "Subaru",
    "model": "FORESTER",
    "status": "Действует",
    "startDate": "01.01.2020",
    "endDate": "31.12.2020"
}