Skip to main content
POST
/
v1
/
accounts:connect
Action Connect
curl --request POST \
  --url https://api.volteras.com/v1/accounts:connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "returnUrl": "<string>",
  "scopes": [
    "vehicle:all"
  ],
  "deviceTypes": [
    "VEHICLE"
  ],
  "locale": "en-GB",
  "integrationMethod": "<unknown>",
  "chargerLocationLatitude": 123,
  "chargerLocationLongitude": 123,
  "countryCode": "<string>",
  "makes": [
    "BMW"
  ],
  "urlExpiration": 3600,
  "region": "NORTH_AMERICA",
  "vin": "<string>",
  "model": "<string>",
  "modelYear": 123
}
'
{
  "authenticationUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
returnUrl
string<uri>
required

The url the user is redirected to at the end of the consent flow

Minimum string length: 1
​
scopes
enum<string>[]
required

List of scopes that the application requires access to

Minimum array length: 1
Available options:
vehicle:all,
vehicle:charging_history,
vehicle:driving_behavior,
vehicle:location_history,
vehicle:telemetry,
vehicle:information,
vehicle:commands,
battery:all,
battery:telemetry,
geofences:all,
geofences:read,
geofences:write
​
deviceTypes
enum<string>[]
required

Only show these device types in the consent flow. If only one device is selected, the device selection page is skipped.

Minimum array length: 1

All supported device types

Available options:
VEHICLE,
BATTERY,
CHARGER,
INVERTER,
HEAT_PUMP
​
locale
enum<string> | null

Set the language used in the the consent flow. The default is English.

Available options:
en-GB,
de-DE,
fr-FR,
nl-NL
​
integrationMethod
any | null

This is for when a make can be connected via multiple methods. For example, if the make is BMW, the user can connect via the BMW Energy API (for smart charging) or via BMW Cardata (for other vehicle data).

​
chargerLocationLatitude

The latitude of the charger location that the vehicle will be charging at. This is passed in specific cases to the OEM's Portal when the consent flow runs (currently only for BMW), to make it easier for the user to select their charger location, which in turn is needed (currently only for BMW) to restrict when start / stop charge commands can be sent.

​
chargerLocationLongitude

The longitude of the charger location that the vehicle will be charging at. This is passed in specific cases to the OEM's Portal when the consent flow runs (currently only for BMW), to make it easier for the user to select their charger location, which in turn is needed (currently only for BMW) to restrict when start / stop charge commands can be sent.

​
countryCode
string | null

The ISO 3166-1 alpha-2 country code (e.g. DE, GB, US etc.) of the account's country. This is required when it is necessary to fetch the key specifications (model, model year, trim, battery capacity etc.) for vehicles in the account.

​
makes
enum<string>[] | null

Only show these makes of device in the consent flow

Implemented makes enum

Available options:
BMW,
MINI,
HYUNDAI,
KIA,
TESLA,
AUDI,
SEAT,
SKODA,
VOLKSWAGEN,
CUPRA,
VOLVO,
ENPHASE,
MERCEDES,
TESLA ENERGY,
ABARTH,
ALFA ROMEO,
CHRYSLER,
CITROEN,
DODGE,
DS AUTOMOBILES,
FIAT,
JEEP,
LANCIA,
MASERATI,
OPEL,
PEUGEOT,
RAM,
VAUXHALL,
STELLANTIS,
FORD,
NISSAN,
POLESTAR
​
urlExpiration
integer | null
default:3600

Defines the validity period of the authentication URL in seconds. Defaults to 3600, with a range between 3600 seconds (1 hour) and 1209600 seconds (2 weeks). Once expired, the URL becomes invalid and cannot be used.

Required range: 3600 <= x <= 1209600
​
region
enum<string> | null

Defines the geographic region for the account connection, directly influencing which OEM-specific API endpoint will be used for the connection. For OEMs with distinct APIs across regions, this setting ensures the correct regional API is utilized. The default is Europe.

Available options:
NORTH_AMERICA,
EUROPE
​
vin
string | null

The VIN to connect, if connecting via the VIN upload flow.

​
model
string | null

The model to connect, if connecting via the VIN upload flow.

​
modelYear
integer | null

The model year to connect, if connecting via the VIN upload flow.

Response

200 - application/json

Successful Response

​
authenticationUrl
string
required

The URL to redirect the user to for authentication through the connect flow.