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"
  },
  "created": "2023-11-07T05:31:56Z",
  "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": "Household"
    },
    "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",
      "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>"
    }
  ]
}

​
Required Parameters

​
type
enum<string>
required

Specify the type of device or vehicle that you want to connect with.
Available options are Battery, Boiler, ChargePole, EV, HeatPump, PV, RetrofitMeter, and SmartMeter.

​
manufacturer
string
required

Specify the manufacturer (for example: “Audi” or “Huawei”) of the device or vehicle you want to connect with. List all available Entity manufacturers to learn about the available options.

​
Device Identifiers

Most manufacturers assign a unique identifier to their devices. Depending on the type or brand of the device you’re onboarding, you may need to provide one or more of these identifiers to complete the request.

Onboarding something else? Read our guide on manual onboarding.

​
Detailed Endpoint Reference

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

Response

201
application/json
Created

Represents an onboarding request