Guided onboarding is a new feature, available only to onboard EVs of compatible manufacturers.

Guided Onboarding enables your users to onboard their device themselves through a web-based UI. This allows us to interact directly with your users, greatly minimizing the integration effort.

Let’s get started by creating your first guided onboarding session!

​
What you’ll need

  • Your API credentials and a Tenant or Collective ID
  • A way to share the session with the vehicle’s owner

You don’t need to know the vehicle’s identification number (VIN) and its manufacturer when creating the session. However, if you do, you can lock them in before sharing the session.

​
Creating your first session

1

Start a session

Create a Guided Onboarding Session to get started. Optionally, you can specify your , which will be shown in the UI.

If you do not provide them, we’ll ask the session’s user for both their vehicle’s and its . If you specify them when creating the session, you won’t be able to change them through the UI later.

Lastly, you may need to include either a or to complete the request.

2

Share the session with the vehicle's owner

Redirect or share the with the vehicle’s owner. They will be asked to complete all the missing details and to provide consent for the connection.

Response (Body)
{
  "id": "3c90c3cc-[...]-8dd25736052a",
  "url": "<string>"
}
3

Track the session

Use the to Retrieve your Guided Onboarding Session.

As part of the API’s response, you’ll find a snapshot of the which was created automatically as part of your session.

Periodically poll the Onboarding API to check if the status of the onboarding 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.

{
 "id": "3c90c3cc-[...]-8dd25736052a",
 "url": "<string>",
 "expired": true,
 "onboardingRequest": {
   "id": "37dfcfd9-[...]-7e281c732e51",
   "status": "Succeeded",
   "data": {
       "entity": {
           "id": "37dfcfd9-[...]-7e281c732e51",
           ...
       },
   }, ...
 }, ...
}

​
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.