Leap Connect
Customer Journey
Once you have provided your customer the registration URL through your customer journey of choice, the customer will experience the connection process as follows:
- The customer navigates to Leap Connect through the registration link
- Leap redirects the customer to the connection for the partner-specified or customer-selected utility for the customer to authorize data access
- Upon completion, the utility redirects the end-user back to Leap Connect indicating a successful connection
- (Optional): customer agrees to additional terms if required by the program
- Upon completion of the connection process the customer is redirected to a partner specified thank-you page
Leap Connect Overview
The Leap Connect is Leap's partner branded, multi-market service that allows customers to connect their accounts to different utilities and sign additional terms as required by customer type in one session. Once enabled by Leap, partners are able to generate a Leap Connect URL, which includes partner-specific branding, eSign forms and participating utilities. Contact [email protected] to get Leap Connect set up in your account.
Once set up, you can navigate in the Partner Portal to the Connect tab and click the ‘+ Connect link’ button in the top-right corner in order to configure the Leap Connect URL. You can also programmatically create these URLs using the URL structure and variables outlined below.
https://onboarding.leap.energy/<org-name>/<url-friendly-title>/?requestedUtilities=<requested-utility>&refId=<refId>
Connect Variables
| Attribute | Description |
|---|---|
org-name | Leap-generated name for your organization |
url-friendly-title | The name given to the specific Leap Connect flow that will appear in the URL. This is set by your Partner Success Representative when creating the flow. |
requestedUtilities | An optional query parameter. Leaving this parameter blank will show all utilities in the transmission region to the customer. The utilities included in the query parameter will be marked as utility_is_required in the API response. For Commercial customers this “Required” label will also be shown in the Leap Connect user journey. |
refId | An optional but recommended query parameter available to allow for easy synchronization between Leap’s platform and your internal system. This is generally a unique identifier in your internal system for that particular customer. |
Utility IDs
| Region | Utility | ID |
|---|---|---|
| CAISO | Pacific Gas & Electric (PG&E) | pge |
| CAISO | Southern California Edison (SCE) | sce |
| CAISO | San Diego Gas & Electric (SDG&E) | sdge |
| NYISO | Consolidated Edison (ConEd) | cecony-utilityapi |
| NYISO | Orange and Rockland Utilities (O&RU) | oru-utilityapi |
| NYISO | PSEG Long Island (PSEG-LI) | psegli-utilityapi |
Utilities not listed in this table are not currently supported by Leap Connect.
Supported Regions & Customer Types
| Region |
|---|
| CAISO |
| NYISO |
| Customer Types |
|---|
| Residential |
| Commercial |
If you are a current or prospect Leap partner looking to test Leap Connect, please contact [email protected] to get Leap Connect setup on your account.
Setup & Developer Notes
Reference ID
You can utilize the refId query parameter noted above to link Leap's records to your internal records. Every meter record that is created on Leap's platform will contain the Reference ID that was provided in this query parameter as the partner_reference field in the Get and Search Meters API responses. You can then use the partner_reference to match meters in Leap's platform with customer accounts in your system. However, as this is a simple HTTP GET request, anyone could be making such a request back to your service. You should always ensure authentication and authorization of the user on your own platform. A Leap Connect URL without a Reference ID will not be traceable to a unique meter on the Leap platform.
The reference-id has a 255-character limit and should follow standard URL character restrictions, which are a limited set of characters belonging to the US-ASCII character set. These characters include digits (0-9), letters (A-Z, a-z), and a few special characters ("-", ".", "_", "~"). To prevent potential issues with your authorization URLs, Leap recommends that any unsafe ASCII characters be encoded using percent encoding.
Reference ID Updates
If needed, you can modify these
partner_referencevalues, once a meter is authorized by the customer and on the Leap platform, via the partner portal or using the meter reference API endpoint.
Updated about 23 hours ago