Skip to main content
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"
  },
  "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": [
      "cm"
    ],
    "dispatch_methods": [
      "cm_infrequent_dispatch"
    ],
    "tariff": {
      "tariff_type": "single_rate",
      "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>",
    "type": "boundary meter",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}

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
object
required

Site information Request model for creating a new site.

Example:
{
  "mpan": "1234567890123",
  "postcode": "SW1A 1AA",
  "street_address": "10 Downing Street",
  "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z"
}
​
asset
object
required

Asset information Request model for creating an asset during onboarding (without site_id).

Example:
{
  "external_id": "charger-001",
  "type": "charger",
  "properties": { "power_kw": 7.4 }
}
​
dispatch_consent
object
required

Dispatch consent methods Request model for updating dispatch consent for a site.

Example:
{ "dispatch_methods": ["limited_pause"] }

Response

Successfully onboarded site and asset

Response model for onboarding operation.

​
site
object
required

Created site details Response model for site information.

​
asset
object
required

Created asset details Response model for asset information.