Redirects

Connect returns session_redirect when the user must finish a step on an external page. redirect_type says which page it is and what happens to the session.

`redirect_type`	The user goes to	The session
`SUPPLIER`	Their energy supplier, to sign in and consent to share their tariff	Continues: resume it when the user returns
`OPERATOR_SIGNUP`	A VPP operator’s site, to sign up for a managed tariff	Ends. The user returns later by universal link, with a new session

Tariff connection uses this redirect when the supplier has a DIRECT integration, or a bill upload finds one. The user signs in to the supplier and consents to share their tariff.

Redirect

redirect_url varies by flow and supplier.

{
  "connect_session": "cos_6587fa4362341be5b524de3b",
  "route": "session_redirect",
  "live_mode": false,
  "data": {
    "redirect_type": "SUPPLIER",
    "redirect_url": "https://british-gas-uk.connect.flatpeak.com"
  }
}

Send the user’s browser to redirect_url with a GET, appending the session ID as connect_session. Query parameters you add, such as your own session ID, come back in the callback.

Example redirect

GET /?connect_session=cos_6587fa4362341be5b524de3b HTTP/1.1
Host: british-gas-uk.connect.flatpeak.com

Callback

After the supplier flow, Flatpeak sends the user to the connect_url set on the Connect session: your Connect web app, or a deep link into your app. callback_url is different: Connect sends the user there when the whole session ends.

Example callback

myapp://oauth-callback/flatpeak?connect_session=cos_6587fa4362341be5b524de3b

Resume the session with session_restore:

Your POST to Connect

curl --request POST \
  --url https://connect.flatpeak.com \
  --header 'Content-Type: application/json' \
  --data '{
    "connect_session": "cos_6587fa4362341be5b524de3b",
    "route": "session_restore"
  }'

What the user sees

Most users see two pages: Login, then Consent. Some suppliers add steps such as a one-time password, address selection for accounts with several properties, retry and recovery, or tariff selection.

Login
OTP
Progress
Consent

Pages vary by supplier. Placeholder names such as Nova Inc are replaced with the business name set in Console → Compliance.

Use a sheet

Open supplier pages in a modal or sheet, which avoids the layout problems a full browser window has around camera cut-outs. See iOS sheets and Android bottom sheets.

The Programs page returns this redirect when the user selects a managed tariff. The user reads the offer and signs up on the VPP operator’s site before they consent to anything.

{
  "connect_session": "cos_6587fa4362341be5b524de3b",
  "route": "session_redirect",
  "live_mode": true,
  "data": {
    "redirect_type": "OPERATOR_SIGNUP",
    "redirect_url": "https://pge.com/programs/on-demand-v2g/signup?program_id=vpr_7b2f9d486ec0ef716cbbee57&oem_id=oem_6a3a8dada72cd0a249ff9528&signup_reference=sur_6a7c0e2f9b4d1a3c5e8f7b6d"
  }
}

Open redirect_url exactly as given. Do not append connect_session: the session ID is the only credential on Connect requests, and the VPP operator must not receive it.
Use the system browser, where the VPP operator’s app can take over if the user has it installed. A sheet inside your app cannot hand over to another app.
Close Connect. The session is over: it recorded no consent and created no enrollment, and there is nothing to restore.

redirect_url carries a signup_reference that lets Flatpeak find the device again later; it holds no device or user data. Once the user has signed up, the VPP operator sends them back to your app by universal link with a new Connect session, where they consent and the enrollment starts. That can be minutes or days after the redirect.

Platform

Tariffs

VPP

What the user sees

Use a sheet

Supplier sign-in

What the user sees

Use a sheet

Operator sign-up