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:

  1. Set up credentials to use the Service Account API
  2. Use the vehicle eligibility endpoint by passing in the brand and VIN (Vehicle Identification Number)
  3. 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.

Table of Contents

Supported brands

It's possible to perform eligibility lookups for the following brands:

  • Alfa Romeo
  • BMW
  • Citroën
  • DS Automobiles
  • Ford
  • Fiat
  • Lexus
  • Mercedes-Benz Fleets
  • MINI
  • Opel
  • Peugeot
  • Renault
  • Toyota

Get an Access Token

To authenticate with the eligibility endpoint, you first have to create an OAuth2 Access Token.

  1. Go to the "OAuth" tab in your app view
  2. Note the Auth URI and store your Client ID and Client Secret securely
  3. Use your credentials to to create an Access Token with the client_credentials grant:
curl --location 'https://api.high-mobility.com/v1/access_tokens' \
--header 'Content-Type: application/json' \
--data '{"client_id": "a92cf969-e8ff-4ad4-a45f-42930edde12d", "client_secret": "xfVxR6xnlbeVHXkQatRx4FmxSJxFR0-M", "grant_type": "client_credentials"}'
{
    "access_token": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTgwNzAwMDEsImlhdCI6MTY5ODA2OTcwMSwiaXNzIjoiaHR0cHM6Ly9zYW5kYm94LmFwaS5oaWdoLW1vYmlsaXR5LmNvbS92MS9hdXRoX3Rva2VucyIsInNjb3BlIjoiZmxlZXQ6Y2xlYXJhbmNlIHZlaGljbGU6ZWxpZ2liaWxpdHktY2hlY2sgdmVoaWNsZTpkYXRhIiwic3ViIjoiMjEwZmMyOTUtZDQ5OS00ZDgwLTk5MWUtZTQ3NTZlZDI3YTZmIiwidmVyIjoxfQ.2neMW6LioKvZYlbSTf-W4GwSHQmMr_8cyXfhyi4XJF-6F4HrvFNIsLlNUa93wp6BiJ_XEythR8DfWh0PrIaHrg",
    "expires_in": 300,
    "scope": "fleet:clearance vehicle:eligibility-check vehicle:data",
    "token_type": "bearer"
}

See the authentication tutorial for OAuth2 Client Credentials to get the full details and integration options.

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 keyDescription
vinThe VIN that that was eligibility checked
eligibleTrue or false, if the vehicle can be activated
data_deliveryIf we deliver data over pull, push or both
*connectivity_statusIf the vehicle has an active data subscription
*primary_user_assignedIf 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"
  ]
}