Sites

Onboard site and asset (legacy)

deprecated

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.

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.

POST

entities

site

onboard-site-and-asset

Onboard Site And Asset

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/onboard-site-and-asset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z",
    "email": "test@example.com"
  },
  "asset": {
    "external_id": "charger-001",
    "type": "charger",
    "properties": {
      "power_kw": 7.4
    }
  },
  "dispatch_consent": {
    "dispatch_methods": [
      "limited_pause"
    ]
  }
}
'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [],
    "dispatch_methods": [],
    "tariff": {
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}

We’d recommend migrating to /onboard — it supports multiple assets per site, and a wider variety of common use cases. Existing integrations against /onboard-site-and-asset will continue to be supported.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model for onboarding a site with an asset and dispatch consent in a single call.

site

Site · object

required

Site information

Show child attributes

Example:

{
  "mpan": "1234567890123",
  "postcode": "SW1A 1AA",
  "street_address": "10 Downing Street",
  "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z",
  "email": "test@example.com"
}

asset

Asset · object

required

Asset information

Show child attributes

Example:

{
  "external_id": "charger-001",
  "type": "charger",
  "properties": { "power_kw": 7.4 }
}

Dispatch consent methods

Show child attributes

Example:

{ "dispatch_methods": ["limited_pause"] }

Response

Successfully onboarded site and asset

Response model for onboarding operation.

site

Site · object

required

Created site details

Show child attributes

asset

Asset · object

required

Created asset details

Show child attributes

Offboard site and assetsOffboard a site and all its associated assets in a single operation. Unenrols from every proposition, and deletes the site and assets in accordance with data retention policies. Use when the user is leaving entirely — for example, they've moved house, or your support team is removing them. Payments can no longer be accessed afterwards. If the user is only opting out of one proposition (e.g. toggling Flex Lite off in your app), use `unenrol` instead — it preserves the site and any other propositions they're enrolled in.

⌘I

Onboard Site And Asset

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/onboard-site-and-asset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z",
    "email": "test@example.com"
  },
  "asset": {
    "external_id": "charger-001",
    "type": "charger",
    "properties": {
      "power_kw": 7.4
    }
  },
  "dispatch_consent": {
    "dispatch_methods": [
      "limited_pause"
    ]
  }
}
'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [],
    "dispatch_methods": [],
    "tariff": {
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}