Skip to main content
GET
/
v1
/
onboarding
/
entities
/
{onboardingRequestId}
Retrieve an Entity Onboarding Request
curl --request GET \
  --url https://api.traxes.io/connect/v1/onboarding/entities/{onboardingRequestId} \
  --header 'Authorization: Bearer <token>'
{
  "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": "<unknown>",
      "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": "<unknown>",
      "reference": {
        "brand": "<string>",
        "type": "<string>",
        "identifier": "<string>"
      },
      "systemProperties": "<unknown>",
      "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>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
onboardingRequestId
string<uuid>
required

The id of the Entity Onboarding Request

Response

OK

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