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.
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"] }
