Documentation | Genius APIs

Usage examples together with detailed description about the features and functionality of our APIs can be found here. If you have any question do not hesitate to contact us

Address

Provides accurate and up-to-date data on addresses

API	Description
GET request/Address/recco	Used to retrieve a set of data from industry source for electricity and gas enquiries at the consumer’s address
POST request/Address/Postcode/Ready	Capturing the consumer’s postcode enables accurate pricing for quoting. Energy suppliers price energy differently throughout the UK and varies across core 14 regional areas. These areas are referred to as DNO’s
POST request/Address/recco/details	Returns detailed information from the industry data source for the electricity and gas enquiries
POST request/Address/recco	Used to retrieve a address data from industry source for electricity and gas enquiries for a particular consumer’s address

App

API	Description
DELETE request/App/customer/{customerid}	No documentation available.
DELETE request/App/eliq/user/{usereliqId}	No documentation available.
GET request/App/customer/{customerid}	No documentation available.
GET request/App/customer/{customerid}/complete	No documentation available.
GET request/App/eliq/user/{usereliqId}/AppId	No documentation available.
GET request/App/eliq/user/{usereliqId}/ashp/savings	No documentation available.
GET request/App/eliq/user/{usereliqId}/ashp/savings/current	No documentation available.
GET request/App/eliq/user/{usereliqId}/savings	No documentation available.
GET request/App/eliq/user/{usereliqId}/tariffswitching	No documentation available.
POST request/App/customer	No documentation available.
PUT request/App/customer/{customerid}	No documentation available.

Bank

Provides verification of Bank details for a switch

API	Description
GET request/Bank/Direct/Valid-Info	Used to validate a consumer’s bank account and sort code for direct debit ONLY payment methods during consumer energy switching

CarbonCLevel

API	Description
GET request/clevel/customer/carbonoffset/payment/update	pdates the customer carbon offsetting payment Reference
GET request/clevel/customer/carbonoffset	No documentation available.
GET request/clevel/equivilantco2/{co2kg}	Returns the Equivilant CO2 Amount
GET request/clevel/projects	Returns the projects that adfre linked to the API KEy
POST request/clevel/calculate/gascarbonoffset	Calculate the Carbon Offset for a given amount of CO2
POST request/clevel/customer/carbonoffset/payment	No documentation available.
POST request/clevel/customer/carbonoffset	No documentation available.
PUT request/clevel/customer/carbonoffset	No documentation available.

Customer

General management of customers

API	Description
GET request/Customer/eliq/user/{usereliqId}/details	No documentation available.
POST request/Customer/esa/ashp/quote	No documentation available.
POST request/Customer/esa/ev/quote	No documentation available.
POST request/Customer/esa/solar/quote	No documentation available.
POST request/Customer/sales/report	No documentation available.
PUT request/Customer/esa/ashp/quote	No documentation available.
PUT request/Customer/esa/ev/quote	No documentation available.
PUT request/Customer/esa/solar/quote	No documentation available.

Estimation

Approximation of current utility consumption

API	Description
GET request/Estimation/detail/all	Used to estimate consumer household energy usage if they otherwise do not know their actual consumption and/or spend. The other option in conjunction to actuals and estimation, is to offer the consumer a default set of consumption values i.e. ‘High’, ‘Med’, ‘Low’. These values should be maintained as governed by Ofgem. N.b. If the property has a 2 rate Economy 7 meter, the night consumption must be captured when asking for actuals.
POST request/Estimation/detail/all	Used to estimate consumer household energy usage if they otherwise do not know their actual consumption and/or spend. The other option in conjunction to actuals and estimation, is to offer the consumer a default set of consumption values i.e. ‘High’, ‘Med’, ‘Low’. These values should be maintained as governed by Ofgem. N.b. If the property has a 2 rate Economy 7 meter, the night consumption must be captured when asking for actuals.
POST request/Estimation/Usage	Returns the applicable data points in order to capture the consumer’s estimated energy usage. Returns the estimated consumption in kWh based on the estimation data captured and the type of quote being rendered. See ‘Switch Request’ API for available consumer energy quote scenarios.

ManageTariff

API	Description
GET request/manage/tariff/{TariffId}	No documentation available.
GET request/manage/tariff/list	No documentation available.
GET request/manage/tariff/lookup/archetype	No documentation available.
GET request/manage/tariff/lookup/scenario	No documentation available.
POST request/manage/tariff/create	No documentation available.
POST request/manage/tariff/export	No documentation available.

Partners

API	Description
POST request/partners/tariff	Returns all the tariffs based on the tariff requests distIds = [ "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23" ] paymentIds = [ 1 (Monthly DD), 2 (Prepayment), 3 (Cash/Cheque), 4 (Quaterly DD)] fuelTypes = ["elecgas", "elec", "gas" ] meterTypes = [ "E7", "STD" ] datestoUse = [ "onsale-dates", "regulatory-dates", "regulatory-dates-with-3-month-buffer", "no-dates" ]

API

Description

POST request/partners/tariff

Returns all the tariffs based on the tariff requests distIds = [ "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23" ] paymentIds = [ 1 (Monthly DD), 2 (Prepayment), 3 (Cash/Cheque), 4 (Quaterly DD)] fuelTypes = ["elecgas", "elec", "gas" ] meterTypes = [ "E7", "STD" ] datestoUse = [ "onsale-dates", "regulatory-dates", "regulatory-dates-with-3-month-buffer", "no-dates" ]

Ppp

Personal Projection Plan (Ppp) for each tariff

API	Description
POST request/ppp	Returns detailed information to compile a calculated comparison between existing and new supplier tariffs. An example display for the Personal projection plan (Ppp) can be viewed through the ‘More Info’ button on the MyUtilityGenius demo quote page for any shown supplier. Additional information can be found on the Ofgem website regarding Ppp.

Report

API	Description
GET request/report/{reportId}	No documentation available.
POST request/report/all	No documentation available.

Results

Supplier and Tariff options for a Genius Switch

API	Description
GET request/Results/tou/esa/ashp/result	No documentation available.
GET request/Results/tou/esa/ev/result	No documentation available.
GET request/Results/tou/esa/solar/result	No documentation available.
POST request/Results/Detail	Gets a collection of possible Tariffs - in detail - a customer can switch to. If a non-compulsory Body Parameter is NOT specified, the results shown will presume that the non-compulsory Body Parameter is NOT to be taken into account and that only the default behaviour should apply. The default behaviour is that CalculateSavingsFromPreviousTwelveMonthsCost is false
POST request/Results/Detail/Split	Gets all possible tariffs a customer can switch to based on All or specific supplier with detail. If a non-compulsory Body Parameter is NOT specified, the results shown will presume that the non-compulsory Body Parameter is NOT to be taken into account and that only the default behaviour should apply. The default behaviour is that CalculateSavingsFromPreviousTwelveMonthsCost is false

Suppliers

Supplier information for a prospective Genius Switch customer

API	Description
GET request/Suppliers/address	No documentation available.
GET request/Suppliers/contact/info	Supplier contact phone and email addresses
GET request/Suppliers/creditcheck	No documentation available.
POST request/Suppliers	Returns energy suppliers applicable on the type of quote being rendered through ‘Switch Request’ and the consumer’s current payment method captured
POST request/Suppliers/list	Returns a set of Energy Supplier logos

SwitchPro

Professional genius switching service with option of complete control over layout and presentation to target audience

API	Description
GET request/Switch/Pro/Info/Address/v2	Returns consumer address details through upfront quote journey capture.
POST request/Switch/Pro/Complete	Completes consumer’s switch to a new energy supplier.
POST request/Switch/Pro/Detail/Direct-Debit-Days	Returns a selection of dates for a consumer switching energy to choose a preferred direct debit payment date as mandatory.
POST request/Switch/Pro/Detail/Employment-Statuses	Returns a selection of employment statuses for a consumer switching energy as mandatory. (Some energy suppliers request this information, contact MyUtilityGenius to confirm which suppliers request this).
POST request/Switch/Pro/Detail/Language	Returns a selection of language preference for a consumer switching energy to provide as optional
POST request/Switch/Pro/Detail/Pre-Payment-Meters	Returns a selection of Prepayment key types for a consumer switching energy as mandatory. (Some energy suppliers request this information, contact MyUtilityGenius to confirm which suppliers request this).
POST request/Switch/Pro/Detail/Residential-Statuses	Returns a selection of residential statuses for a consumer switching energy as mandatory. (Some energy suppliers request this information, contact MyUtilityGenius to confirm which suppliers request this).
POST request/Switch/Pro/Detail/Special-Needs	Returns a selection of ailments (PSR) for a consumer switching energy to provide as optional.
POST request/Switch/Pro/Detail/Terms-And-Conditions	Returns a set of specific energy supplier consents (opt in/out) captures for a consumer switching energy to provide as mandatory and/or optional.
POST request/Switch/Pro/Detail/Titles	Returns a selection of titles for a consumer switching energy as mandatory.
POST request/Switch/Pro/hold/switch	No documentation available.
POST request/Switch/Pro/Info/Address	Returns consumer address details through switching journey capture.
POST request/Switch/Pro/Info/Address/Switch-Postcode	Returns consumer postcode details.
POST request/Switch/Pro/Info/Bank	Returns consumer bank details.
POST request/Switch/Pro/Info/Personal	Returns consumer personal details.
POST request/Switch/Pro/Info/Switch-Plan	Returns consumer’s desired new energy tariff plan. Tariff details can be shown during a consumer switching energy dependent on how the consumer switching journey is built.
POST request/Switch/Pro/Info/Terms-And-Conditions	Returns consumer supplier opt/in out consents.
POST request/Switch/Pro/Key	Returns the consumer switching key for the energy quote along with all details captured necessary for the consumer to be switched.
POST request/Switch/Pro/Update/Address	Returns a set of specific address detail capture for a consumer switching energy to either provide or has already provided as mandatory. Updates to address is NOT recommended. The consumer must start a new quote journey if the address requires updating.
POST request/Switch/Pro/Update/Bank	Returns a set of specific bank detail captures for a consumer switching energy to either provide or has already provided as mandatory. (Direct debit only switches). Bank details can be updated dependent on how the consumer switching journey is built.
POST request/Switch/Pro/Update/Personal	Returns a set of specific personal detail captures for a consumer switching energy to either provide or has already provided as mandatory and/or optional. Personal details can be updated dependent on how the consumer switching journey is built.
POST request/Switch/Pro/Update/Terms-And-Conditions	Adds/Updates terms and conditions for a customer's switch. Default values for AllUpdatesRemindersAndThirdPartyOverride and AllUpdatesRemindersOverride is null. Note that the information obtained at "POST request/Switch/Pro/Detail/Terms-And-Conditions" overrides the Additional Information in the Body Parameters that are stated here.

Switch

General management of customer switches

API	Description
POST request/Switch/create	No documentation available.
POST request/Switch/Dual-Consolidated	Postcode upfront ONLY data capture for consumer energy quote and switching who is on Dual Consolidated fuel set up which means the property has access to both energy types with the same energy providers
POST request/Switch/Dual-Distinct	Postcode upfront ONLY data capture for consumer energy quote and switching who is on a Dual Distinct fuel set up which means the property has access to both energy types with separate gas and electricity providers.
POST request/Switch/Electricity	Postcode upfront ONLY data capture for consumer energy quote and switching who is on a single fuel set up which means the property has access to only electricity.
POST request/Switch/Gas	Postcode upfront ONLY data capture for consumer energy quote and switching who is on a single fuel set up which means the property has access to only gas (This is a very rare occurrence as majority of households depend on power as opposed to gas only).
POST request/Switch/update	No documentation available.
POST request/Switch/v2/Dual-Consolidated	Postcode and address upfront data capture for consumer energy quote and switching who is on Dual Consolidated fuel set up which means the property has access to both energy types with the same energy providers.
POST request/Switch/v2/Dual-Distinct	Postcode and address upfront data capture for consumer energy quote and switching who is on a Dual Distinct fuel set up which means the property has access to both energy types with separate gas and electricity providers.
POST request/Switch/v2/Electricity	Postcode and address upfront data capture for consumer energy quote and switching who is on a single fuel set up which means the property has access to only electricity.
POST request/Switch/v2/Gas	Postcode and address upfront data capture for consumer energy quote and switching who is on a single fuel set up which means the property has access to only gas (This is a very rare occurrence as majority of households depend on power as opposed to gas only).

Tariffs

Tariff information for a prospective Genius Switch customer

API	Description
GET request/Tariffs/export/tariff/{tariffId}/prices	No documentation available.
GET request/Tariffs/export	No documentation available.
POST request/Tariffs	Returns energy suppliers tariffs applicable for the quote being rendered through ‘Switch Request’ and the consumer’s current payment method captured.
POST request/Tariffs/all	No documentation available.
POST request/Tariffs/Tariff/Information	Gets additional information specific to a particular tariff.
POST request/Tariffs/tou	Display ToU tariffs details and prices by DNO,FuelId and Paymenttype.

Til

Tariff Information Label (Til) for each tariff

API	Description
POST request/Til	Returns detailed information to compile factual tariff data comparison between existing and new supplier tariffs. An example display for the Tariff information Label (TiL) can be viewed through the ‘More Info’ button on the MyUtilityGenius demo quote page for any shown supplier. Additional information can be found on the Ofgem website regarding TiL.
POST request/Til/Direct	Gets the Tariff Information Label (Til) for a specific tariff.