Vehicle Eligibility Tutorial

The Service Account 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:

  1. Set up credentials to use the Service Account API
  2. Use the Telematics Status endpoint by passing in a VIN (Vehicle Identification Number)
  3. The response will both tell you if the vehicle has the right equipment and an active connectivity subscription

Brand support

At the moment the eligibility check only works for BMW and MINI vehicles. Support for more brands is added soon.

Table of Contents

Create and sign a JWT

Before using the telematics status 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 telematics status endpoint of the Service Account API is used to check the eligibility. It's a simple API where all you need to do is to pass in the VIN.

Check out the Open API Specification to see the reference of the POST /telematics_status endpoint.

# change ACCESS TOKEN and VIN
curl --location --request POST 'https://api.high-mobility.com/v1/telematics_status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <ACCESS TOKEN>' \
--data-raw '{"vin": "<VIN>" }'

The response will look something like this:

{
  "bmw": {
    "telematics_capability": "enabled",
    "subscription_status": "enabled"
  }
}