Vehicle Eligibility Tutorial
The Eligibility API enables you to do lookups of specific vehicles to see if they are capable of providing data to your application. The lookup works through these steps:
- Set up credentials to use the Service Account API
- Use the vehicle eligibility endpoint by passing in the brand and VIN (Vehicle Identification Number)
- The response will tell you if the vehicle has the right equipment in order to be activated for data sharing.
Production Applications
Note that you can only perform lookups for brands that have been activated for your production application.
Supported brands
It's possible to perform eligibility lookups for the following brands:
- Alfa Romeo
- BMW
- Citroën
- DS Automobiles
- Ford
- Fiat
- Mercedes-Benz Fleets
- MINI
- Opel
- Peugeot
Create and sign a JWT
Before using the vehicle eligibility endpoint of the Service Account API, it's best to get familiar with the API and what's needed in order to get a JWT for each request. Read all about it in the Service Account Tutorial.
Checking the eligibility of a vehicle
The eligibility endpoint is used to check the eligibility. It's a simple API where all you need to do is to pass in the brand and VIN.
Check out the Open API Specification to see the reference of the POST /eligibility endpoint.
# change ACCESS TOKEN, BRAND and VIN
curl --location --request POST 'https://api.high-mobility.com/v1/eligibility' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <ACCESS TOKEN>' \
--data-raw '{"brand": "<BRAND>", "vin": "<VIN>" }'
Here's a breakdown of the information you receive:
| JSON key | Description |
|---|---|
| vin | The VIN that that was eligibility checked |
| eligible | True or false, if the vehicle can be activated |
| data_delivery | If we deliver data over pull, push or both |
| *connectivity_status | If the vehicle has an active data subscription |
| *primary_user_assigned | If the vehicle is assigned to a primary owner |
* This is optional information, that is only available for a few brands.
The response will look something like this:
{
"vin": "EXVETESTVIN000001",
"eligible": true,
"data_delivery": [
"pull",
"push"
]
}