Connect to an electric vehicle
Get access to vehicle readings, control charging, and list charge sessions.
What you’ll need
- Your API credentials and a Tenant or Collective ID
- The vehicle’s identification number (VIN) and its manufacturer
- A way to reach out to the vehicle’s owner for consent
Locating the VIN

Let’s get started
Start the onboarding process
Create an Entity Onboarding Request, setting the to EV
.
You’ll need to specify a supported and the vehicle’s as a unique device identifier.
List all available Entity manufacturers to learn about the available options.
Lastly, you may need to include either a or to complete the request.
Check for required actions
In most cases, the onboarding request will have the Pending
until a required is completed.
How an action should be completed, depends on its .
- Actions of type
Redirect
(most common) contain a . You can redirect your user here or share this link directly with the vehicle’s owner to complete the action. - Actions of type
Consent
have to be completed through the vehicle manufacturer’s app or by responding to a notification. They also contain a for more information on how to complete the action.
Track the onboarding status
Periodically poll the Onboarding API to check if the status of your request has updated to Succeeded
. Once it’s complete, you’ll find the newly created Entity and its ID in the object.
You can reference the when using our Readings API, Commands API, and our Charge Sessions API.
Work with your newly created Entity
Tip: Take note of your Entity ID before you get started with our APIs.
Readings API
Observe the state of the vehicle.
Commands API
Send charging instructions.
Charge Sessions API
See when the vehicle charged.