Onboard site and asset
Onboard a site with an asset and dispatch consent in a single operation.
This composite endpoint combines the functionality of creating a site, creating an asset, and adding dispatch consent. The operations are performed in sequence:
-
Create the site
-
Create the asset associated with the site
-
Add dispatch consent to the site
-
Add boundary meter consent to the site (if provided)
If any step fails, the operation will be rolled back.
Note: You cannot onboard sites without a valid MPAN. Use /meter/ endpoints to obtain MPANs.
Documentation Index
Fetch the complete documentation index at: https://docs.axle.energy/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Request model for onboarding a site with an asset and dispatch consent in a single call.
Site information
{
"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 information
{
"external_id": "charger-001",
"type": "charger",
"properties": { "power_kw": 7.4 }
}Dispatch consent methods
{ "dispatch_methods": ["limited_pause"] }
