Skip to main content
If you need more granular control over the onboarding process — for example, to insert eligibility checks or other functionality between site creation and enrollment — you can use the initialise and enrol endpoints instead of the single onboard-site-and-asset call.

​
How it works

The onboard-site-and-asset endpoint combines site creation, asset creation, and enrollment in a single call. The advanced flow breaks this into separate steps:
  1. Initialise — creates the site and assets (with upsert semantics for existing entities), and returns eligibility information. No enrollment side effects.
  2. Eligibility — the initialise response includes eligibility data for the site. You can also re-check later via the standalone eligibility endpoint.
  3. Enrol — the commitment point. Grants dispatch consent, syncs market participation, and awards any applicable bonus.
This is useful when:
  • You want to check eligibility before committing to enrollment
  • You need to collect additional consent or information between site creation and enrollment
  • Your site or assets may already exist (e.g. from Capacity Market participation) and you want to update them — onboard-site-and-asset will return a 409 Conflict in this case, whereas initialise will upsert
  • You want visibility into what changed — initialise returns whether each entity was created or already existed, which fields were updated, and any relevant warnings
To reverse enrollment, use the unenrol endpoint — this stops participation without deleting the site, so the user can re-enrol later.

Initialise

Create/upsert site and assets

Check eligibility

Check site eligibility

Enrol

Enrol site in a proposition

Unenrol

Unenrol from a proposition