Onboard Site And Asset

Deprecated — prefer /onboard instead.

The new /onboard endpoint supports multiple assets per site in a single call and includes improvements in idempotency, resilience and response details.

Register a site, asset, and dispatch consent in a single call.

Creates the site and asset, grants consent, and enrols in the relevant flex proposition.

This endpoint will:

Create the site
Create the asset associated with the site
Enrol in the relevant flex proposition

Returns the created site and asset, including their IDs. Fails if the site or asset already exists.

Request body

Example request

{
  "asset": {
    "external_id": "charger-001",
    "asset_model": "axle_charger_v1",
    "installation_date": "2025-06-15"
  }
}

Response

Successfully onboarded site and asset