Vehicle Eligibility

Check if a vehicle is eligible for data sharing using its brand and VIN

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.

Supported brands

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

• BMW brands: bmw/mini

• Stellantis brands: alfaromeo/citroen/ds/fiat/ jeep/maserati/opel/peugeot/vauxhall

• Toyota brands: toyota/lexus

• Renault brands: renault/daica

• Ford brand: ford

• Volvo Cars brand: volvo-cars

• Mercedes-Benz: mercedes-benz

API usage

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.

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

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.