Skip to main content

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.

Before onboarding users, you need to collect their address, check eligibility, and obtain consent. This ensures only qualifying users participate in the program.

​
Address collection

The first step is collecting the user’s address. This allows you to look up their MPAN (Meter Point Administration Number), which is required for eligibility checks and program participation.

Collecting addresses

Learn how to implement an address collection workflow
Once you have the user’s address, you can look up their MPAN information.

Get MPAN from address

Learn how to retrieve meter details

​
Eligibility status

Use the check-eligibility endpoint to find out which propositions a site qualifies for, to determine whether proceed with the user offering. Pass the MPAN, and optionally a charger model.

Check eligibility

Check the eligibility of a site without persisting any data.
You control eligibility - by default, we will only let market-qualified users participate in flex propositions, but we can expand access based on your preferences.
Once you’ve identified an eligible user, you need to obtain their consent to participate. This is typically done through an update to your Terms & Conditions that users must agree to before onboarding. You’ll need to capture a timestamp indicating when the user agreed to these terms.
Store the consent timestamp securely - you’ll need to provide it during the onboarding process to confirm the user has agreed to participate.

​
Next Steps

Once you’ve collected:
  • MPAN - from the address lookup
  • Consent timestamp - when the user agreed to the terms
You’re ready to move ahead with integration:

Smart Charging Integration

Start onboarding eligible users to Smart Charging

Flex Lite Integration

Start onboarding eligible users to Flex Lite