Virtual Key Status

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/virtual_key" \
-H "Authorization: Bearer {token}" \
-X "GET"

{
    "isPaired": true
}

GET

v2.0

vehicles

{id}

{make}

virtual_key

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/virtual_key" \
-H "Authorization: Bearer {token}" \
-X "GET"

{
    "isPaired": true
}

This endpoint is currently available for tesla

Permission

read_vehicle_info

Path

string

required

The vehicle ID of the vehicle you are making a request to.

make

string

required

The make of the vehicle you are making a request to.

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/virtual_key" \
-H "Authorization: Bearer {token}" \
-X "GET"

isPaired

boolean

Returns true if the vehicle has the appropriate Virtual Key installed. See Tesla - What’s New for more details on Tesla’s virtual key requirements.

{
    "isPaired": true
}

This endpoint will throw a COMPATIBILITY:PLATFORM_NOT_CAPABLE error if a vehicle is connected to your application via Tesla’s legacy integration.
This endpoint will throw a CONNECTED_SERVICES_ACCOUNT:VEHICLE_MISSING error if the Tesla account connected to Smartcar is not the Owner of the vehicle. See our FAQs for more information on Owner and Driver account types.