Provider (supplier) Selector

This step allows the customer to select their energy provider from a pre-populated list. If their provider is not listed, they can enter it manually using the PROVIDER_MISSING action described below. Your application should support both paths to ensure all customers can complete the connection flow.

Preview
Code

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "provider_select",
  "tariff_direction": "IMPORT",
  "tariff_type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "ADDRESS_CHANGE",
    "PROVIDER_MISSING",
    "BACK"
  ],
  "data": {
    "postal_address": {
      "address_line1": "1-3",
      "address_line2": "Strand",
      "city": "London",
      "state": "Greater London",
      "post_code": "WC2N 5EH",
      "country_code": "GB"
    },
    "providers": [
      {
        "id": "prv_65b78bbdd8e83b06a60e38c2",
        "display_name": "British Gas",
        "logo_url": "https://s.flatpeak.com/83b06a60e38c2.png",
        "connection_types": ["DIRECT", "MARKET"]
      },
      {
        "id": "prv_64b83f455cb6e881442244f8",
        "display_name": "EDF Energy",
        "logo_url": "https://s.flatpeak.com/6e881442244f8.png",
        "connection_types": ["DIRECT", "LIBRARY"]
      }
    ]
  }
}

Actions

Following actons are supported when responding to Connect on this route:

Action	Result
`ADDRESS_CHANGE`	Returns Postal Address page
`PROVIDER_MISSING`	Returns next page depending on Connect flow logic
`BACK`	Returns previous page.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Errors

When you POST your response to Connect, the following validation errors may be returned:

Error Code	Error Description
`provider_id_missing`	Provider ID is required.
`provider_not_found`	Provider ID prv_XX not found.
`provider_id_invalid`	Provider ID prv_XX is not available at your address (XX).
`data_json_invalid`	Data does not conform to the JSON schema.

Documentation Index

​Actions

​Errors

Actions

Errors