added
YearMakeModel Endpoint
4 months ago by Root Insurance
With a VIN (or partial VIN) decode the Year, Make, and Model of a vehicle.
/v3/ymm_for_vin/:vin
Get YearMakeModel
/v3/ymm_for_vin/:vin
Get YearMakeModelReleased: [2024-11-25]
The YearMakeModel endpoint allows users to provide a VIN and returns the year
, make
, and model
of the associated vehicle.
Key Notes
- Optional: This endpoint is not required in the process of quoting or binding. Please see your Root representative to request access to this optional endpoint.
- Request VIN: Accepts a case insensitive full/short VIN in the request path
- Response Data: Returns vehicle information decoded from the VIN,
year
,make
, andmodel
.
Usage Example
GET /v3/ymm_for_vin/vin
Content-Type: application/json
Sample Response
{
"Make": "Acura",
"Model": "RL",
"Year": "2014"
}
Notes:
- YearMakeModel Access: For successful VIN lookup, access to this endpoint needs to be enabled.
- Error Handling:
- If the VIN is invalid, the endpoint returns a
201
response withnull
values.{ "Make": null, "Model": null, "Year": null } - If no information is retrieved, the endpoint returns a
422 Unprocessable Entity
. - If YearMakeModel access is not enabled, the endpoint returns a
401 Unauthorized
response indicating that access is not enabled.
- If the VIN is invalid, the endpoint returns a