DIRECT– Instant, authenticated connectionLIBRARY– Selection for Flatpeak-maintained libraryMARKET– Automatically links market-based tariff by geo-locationMANUAL– Customer input as a last resort
Explore DIRECT provider integrations coverage and MARKET coverage
- Simplified flow diagram
- Detailed flow diagram
Connect modules
The Flatpeak Connect is composed of two modules:1. Main module
This module manages the core user interaction flow, including:- Postal address input
- Provider selection
- Market tariff connection (headless & automatic)
- Library tariffs
- Surcharges
- Manual tariff input
- Tariff summary display (and edit)
- Forking Flatpeak’s reference implementation and customise it and integrate via WebView, or
- Implement in your your apps’ native framework by integrating Connect API (recommended).
2. Auth module
When a customer selects a provider with a direct integration to Flatpeak, they are redirected to the Auth module (shown in green in the diagram above). This module handles:- Redirecting to the energy provider’s authentication page
- Secure login at the provider’s page
- Return to the Main module

Example pages within Connect flow modules
URL parameters when creating Connect tokens
When calling the create-connect-token endpoint , you must specify the environment URLs used during the Connect flow.| Parameter | Description |
|---|---|
connect_url | URL the customer is redirected to during the Handling Callback step of the Provider Login Redirect. Specify either the URL where your Connect web app is hosted or a deep link into your native app. |
callback_url | URL where the customer is redirected after they complete or exit their Connect session. |

