POST
/
v1
/
onboarding
/
entities
curl --request POST \
  --url https://platform.realto.io/api/v1/onboarding/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "ean": "<string>",
  "email": "<string>",
  "manufacturer": "<string>",
  "model": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<any>",
  "reference": "<string>",
  "returnUrl": "<string>",
  "track": "<string>",
  "type": "Battery",
  "uuid": "<string>",
  "vin": "<string>"
}'
{
  "action": {
    "documentationLink": "<string>",
    "redirectLink": "<string>",
    "type": "Consent"
  },
  "data": {
    "collective": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "properties": "<any>",
      "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "Community"
    },
    "entity": {
      "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "information": {
        "code": "<string>",
        "ean": "<string>",
        "email": "<string>",
        "manufacturer": "<string>",
        "model": "<string>",
        "reference": "<string>",
        "track": "<string>",
        "type": "Battery",
        "uuid": "<string>",
        "vin": "<string>"
      },
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "properties": "<any>",
      "reference": {
        "manufacturer": "<string>",
        "type": "<string>",
        "reference": "<string>"
      },
      "systemProperties": "<any>",
      "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "Battery"
    },
    "tenant": {
      "type": "Company",
      "administrator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "user": {
      "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "givenName": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "language": "<string>",
      "surname": "<string>",
      "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "client": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isTenantAdmin": true
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestType": "Collective",
  "returnUrl": "<string>",
  "status": "Canceled",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Body

The Entity Onboarding Request. The entity needs to be placed in a Collective or a Tenant. As such either collectiveId or tenantId is required

Represents a request to onboard an Entity

​
manufacturer
string | null
required

The manufacturer of the Entity

​
type
enum<string>
required
Available options:
Battery,
Boiler,
ChargePole,
EV,
HeatPump,
PV,
RetrofitMeter,
SmartMeter
​
tenantId
string | null

The id of the Tenant the Entity will be added to. Required to be set if collectiveId is not set.

​
collectiveId
string | null

The id of the Collective the Entity will be added to. Required to be set if tenantId is not set.

​
code
string | null

The code of the Entity

​
ean
string | null

The EAN number of the Entity

​
email
string | null

The email address used to onboard the Entity

​
model
string | null

The model of the Entity

​
owner
string | null

The owner of the Entity

​
properties
any | null

The custom properties of the Entity

​
reference
string | null

The reference 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

​
uuid
string | null

The unique identifier of the Entity

​
vin
string | null

The VIN of the Entity (required in case the type is EV)

Response

201
application/json
Created

Represents an onboarding request

​
action
object

Represents an action for an onboarding request

​
data
object

Represents the data of an onboarding request

​
id
string

The id of the onboarding request

​
principalId
string

The id of the principal that initiated the onboarding request

​
requestType
enum<string>
Available options:
Collective,
Entity,
Tenant,
User,
Client
​
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

Was this page helpful?

List all Entity Onboarding RequestsCancel an Entity Onboarding Request