Eligibility

This API allows lookups to see if a vehicle is eligible for telematics data. The raw Swagger specification is available at https://github.com/highmobility/open-api-specifications/blob/main/hm-eligibility-v1.yml

Check vehicle eligibility

post

/v1/eligibility

Retrieves the eligibility status for a specific VIN. This can be used to find out if the vehicle has the necessary connectivity to transmit data.

Required scopes

This endpoint requires the following scopes:

• : eligibility check

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

vinstringRequired

Vehicle vin.

brandstring · enumRequiredPossible values:

Responses

200

Vehicle eligibility requested successfully

application/json

Response of eligibility check

vinstringRequired

eligiblebooleanRequired

connectivity_statusstring · enumOptionalPossible values:

primary_user_assignedbooleanOptional

401

When an invalid ServiceAccountToken is used.

application/json

422

Errors such as invalid VIN and brand call failed

application/json

post/v1/eligibility

POST /v1/eligibility HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "vin": "text",
  "brand": "mercedes-benz"
}

{
  "vin": "EXVETESTVIN000001",
  "eligible": true,
  "data_delivery": [
    "pull",
    "push"
  ]
}