Skip to main content
POST
/
v1
/
onboarding
/
entities
Create an Entity Onboarding Request
curl --request POST \
  --url https://api.traxes.io/connect/v1/onboarding/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pairingCode": "<string>",
  "associatedEmail": "<string>",
  "brand": "<string>",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<any>",
  "identifier": "<string>",
  "returnUrl": "<string>",
  "track": "<string>",
  "type": "Battery"
}'
{
  "action": {
    "documentationLink": "<string>",
    "redirectLink": "<string>",
    "type": "Consent"
  },
  "created": "2023-11-07T05:31:56Z",
  "data": {
    "collective": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "properties": "<any>",
      "type": "Household"
    },
    "entity": {
      "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "information": {
        "type": "Battery",
        "brand": "<string>",
        "identifier": "<string>",
        "pairingCode": "<string>",
        "associatedEmail": "<string>",
        "name": "<string>",
        "track": "<string>"
      },
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "properties": "<any>",
      "reference": {
        "brand": "<string>",
        "type": "<string>",
        "identifier": "<string>"
      },
      "systemProperties": "<any>",
      "type": "Battery"
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestType": "Collective",
  "returnUrl": "<string>",
  "status": "Canceled",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

​
Important Parameters

​
type
enum<string>
required
Specify the type of device or vehicle that you want to connect with.
Available options are Battery, ChargePoint, EV, HeatPump, SolarPlant, RetrofitMeter, Meter, and Inverter.
​
brand
string
required
Specify the manufacturer (for example: “Audi” or “Huawei”) of the device or vehicle you want to connect with. List all available Entity brands to learn about the available options.
​
identifier
string
A unique identifier asigned by the vehicle or device manufacturer.

​
Additional Parameters

Some manufacturers may require additional identifiers or special parameters to be set to complete this request. Read our dedicated onboarding guides for more information.

​
Detailed Endpoint Reference

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Body

The Entity Onboarding Request.

The entity can be placed in a Collective.

Represents a request to onboard an Entity

​
brand
string | null
required

The brand of the Entity

​
type
enum<string>
required
Available options:
Battery,
ChargePoint,
EV,
HeatPump,
SolarPlant,
RetrofitMeter,
Meter,
Inverter
​
collectiveId
string<uuid> | null

The id of the Collective the Entity will be added to.

​
pairingCode
string | null

The pairing code of the Entity

​
associatedEmail
string | null

The associated email address used to onboard the Entity

​
name
string | null

The name of the Entity

​
owner
string<uuid> | null

The owner of the Entity

​
properties
any

The custom properties of the Entity

​
identifier
string | null

The identifier of the Entity

​
returnUrl
string | null

Represents the url where the user will be redirected to after completing the consent flow on the OEM page

​
track
string | null

The track of the Entity

Response

Created

Represents an onboarding request

​
action
object

Represents an action for an onboarding request

​
created
string<date-time>

The date and time the onboarding request was created.

​
data
object

Represents the data of an onboarding request

​
id
string<uuid>

The id of the onboarding request

​
principalId
string<uuid>

The id of the principal that initiated the onboarding request

​
requestType
enum<string>
Available options:
Collective,
Entity
​
returnUrl
string | null

The url where the User will be redirected to after completing the consent flow on the OEM page.

​
status
enum<string>
Available options:
Canceled,
Failed,
InProgress,
Pending,
Succeeded
​
errors
object[] | null

Errors that occurred during the processing of the onboarding request