Signup Component
Implementing Signup
How to use the Signup Component
Our signup component is provided as a responsive site, either in a standalone, fully managed flow, or as an embed for whitelabeling.
It can be embedded using a standard iframe:
If all the fields are filled for a particular page, it’s skipped entirely.
And then hit your API with that token, in order to obtain relevant user information.
If you prefer, we can also redirect users to a page of your choosing upon success or failure of the signup flow. In this way, we can return users to your site, whilst providing an event for you to update your record of user participation.
Fully managed flow
If you’d like us to handle the entire process, we provide the signup flow with a minimal Axle-branded experience which includes your logo in the top right.Whitelabeled flow
In whitelabeled mode, the signup flow is provided as a smart-phone sized panel on a white background.Passing information into the iFrame
In most cases it’s necessary to collect standard information such as name, address, and contact details. If you already have these details for a given customer, you can pre-populate them by passing them as query parameters to the iframe:Valid Query Parameters
| Parameter | Notes |
|---|---|
| Contact | |
email | Required for any other params to be prefilled |
first_name | |
last_name | |
| Address | |
street_address | |
postcode | Formatted XXX XXX |
city | |
| Meter | |
mpan | The Meter Point Access Number (MPAN) for this customer’s smart meter. We will validate this matches the address the user enters. |
Backend integration
If you would like to pass user information but dislike doing so via the URL, we can integrate with a backend API to retrieve relevant information. In this case, we consume a token from the url:Success and failure URLs
After the flow has successfully completed, our default behaviour is to display our own, market-specific completion page, like this one for the Local Constraint Market (LCM):