How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EDF Energy Account Import API

APIs for importing accounts.

EDF Energy Account Import API is one of 9 APIs that EDF Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 7 operations across 7 paths, and defines 120 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.edfgb-kraken.energy/v1/.

7 operations 7 paths 120 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.edfgb-kraken.energy/v1/graphql/
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

EDF Energy Account Import API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (DRFKrakenTokenAuthentication). An API key is passed in the header as Authorization (DataImportViewerAPIKeyAuthentication).

  • DRFKrakenTokenAuthentication — JWT-based authentication
  • DataImportViewerAPIKeyAuthentication — Token-based authentication with required prefix "Token "

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

account_import 7

APIs for importing accounts.

POST
/v1/data-import/account-import-process/create-or-update/
Use this endpoint to stage account data before creating an account.
V1 Create Or Update Account Import Process body → 200201400
POST
/v1/data-import/account-import-process/process/
Use this endpoint to process staged account data into an account in Kraken.
V1 Process Account Import Process body → 201400429
GET
/v1/data-import/account-transfer-status/{import_supplier_code}/{external_account_number}/
Find out the status of a single account import process
V1 Get Account Transfer Status 2 params → 200404
POST
/v1/data-import/validate-account/
Use this endpoint to validate account data before staging and creating an account.
V1 Validate Account body → 200400
POST
/v2/data-import/accounts/
Schedule the creation of an account in Kraken
V2 Schedule Account Creation body → 201400
GET
/v2/data-import/accounts/{import_supplier_code}/{external_identifier}/
Return the status of an account import process
V2 Account Import Status 2 params → 200404
POST
/v2/data-import/accounts/validate/
Validate the payload for creating an account in Kraken
V2 Validate Account body → 200400

Schemas 120

The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are EnergyAccount (68 properties), EnergyCustomer (28 properties), ElectricityMeterPoint (26 properties), BusinessUser (20 properties). Each schema is shown below with its type and property counts.

LatestError
object
3 properties
EnergyTransaction
Gbr-gas.meter-point-grid-supply-point-equivalentCharacteristic
object
2 properties 2 required
MeterPoint
CreateOrUpdateAccountImportProcess
object
2 properties 2 required
ProcessAccountImportProcessCreation
object
3 properties 1 required
PaymentPromise
object
3 properties 2 required
ElectricityCapacityValue
object
3 properties 2 required
AgreementIntermediaryDetails
object
2 properties 1 required
GasAgreement
object
10 properties 2 required
EnergySmartRefusalInterest
object
4 properties 2 required
AccountConsent
object
4 properties 2 required
PaymentPlanPayment
object
3 properties 3 required
EnergyReading
object
2 properties 2 required
ProcessAccountImportProcess
object
4 properties 2 required
ElectricityAgreement
object
10 properties 2 required
PaymentSchedule
object
17 properties 2 required
GasMeterPoint
object
19 properties 5 required
GasPrepayDebtRepaymentOptions
object
2 properties
EnergyTaxExemption
object
3 properties 2 required
Note
object
7 properties
PartnerOrganisation
object
5 properties 4 required
PaymentPlanPaymentAmountComponent
object
2 properties 2 required
Gbr-electricity.meter-rate-profileCharacteristic
object
2 properties 2 required
TaxItem
object
6 properties 5 required
EnergyCredit
object
9 properties 5 required
ElectricityBespokeRegisterRate
object
4 properties 1 required
ElectricityAgents
object
3 properties
Gbr-electricity.payment-methodCharacteristic
object
2 properties 2 required
SalesChannelCharacteristic
object
2 properties 2 required
PaymentPlan
object
4 properties 4 required
Debt
object
7 properties
PaymentPreferencesWithNewInstructionReferences
object
3 properties 3 required
AccountNotFoundError
object
1 property 1 required
AccountReference
object
2 properties 2 required
EnergyAccount
object
68 properties 1 required
AccountTransferStatus
object
3 properties 1 required
EnergyWarmHomeDiscount
object
3 properties
PaymentAdequacyChange
object
12 properties 9 required
RateOverride
object
2 properties 2 required
ImportStatusResponse
object
6 properties 4 required
BasePaymentPreference
object
2 properties 2 required
Business
EnergyPayment
object
11 properties 4 required
ScheduleAccountCreation
object
2 properties 2 required
ElectricityMeter
object
12 properties 1 required
DepositAgreement
object
5 properties 2 required
ComplaintContact
object
5 properties 5 required
EnergyExtension
object
2 properties 1 required
Ledger
object
2 properties 1 required
PaymentPreferencesWithExistingInstructionReferences
object
3 properties 3 required
ContributionSchemeAgreement
object
6 properties 4 required
EnergyAccountBillingOptions
object
5 properties
Gbr-gas.payment-methodCharacteristic
object
2 properties 2 required
EnergyMeter
object
8 properties 5 required
ElectricityAgentContractReference
object
6 properties
ValidateAccount
object
1 property 1 required
Payments
object
3 properties 2 required
AccountAlreadyImportedResponse
object
3 properties 3 required
ElectricityMeterPoint
object
26 properties 4 required
BusinessWithExistingContracts
object
9 properties
BadProcessAccountImportProcess
GasPrepaymentDetails
object
4 properties 3 required
PortfolioSettings
object
4 properties
BusinessUser
object
20 properties 1 required
ContributionSchemePeriod
object
3 properties 2 required
CustomerConsent
object
4 properties 2 required
ExistingPaymentInstructionReference
object
2 properties 2 required
EnergyCreditHold
object
3 properties 2 required
EnergySmartSiteVisit
object
7 properties 5 required
DRFError
object
Simplistic and mostly inaccurate Serializer that should represent DRF's ValidationError details
1 property
EnergyRepayment
object
11 properties 4 required
Reading
object
4 properties 3 required
ElectricityEstimatedAnnualConsumption
object
4 properties 3 required
BusinessPortfolio
object
4 properties 1 required
EnergyAddress
object
5 properties 2 required
EnergyInstallation
object
4 properties 1 required
NewPaymentInstructionReference
object
1 property 1 required
ProductCharacteristic
GasMeter
object
14 properties 2 required
PortfolioReference
object
2 properties 2 required
Statement
object
7 properties 3 required
EnergyCommissionContract
object
9 properties 5 required
Metadata
object
2 properties 2 required
Address
object
11 properties 1 required
GasAnnualQuantity
object
4 properties 2 required
EnergyFit
object
6 properties 3 required
PaymentInstruction
object
8 properties 3 required
PaymentPreference
GasBespokeGasTariffRate
object
4 properties 2 required
EnergyPSR
object
6 properties
AccountCampaign
object
5 properties
ElectricityBespokeElectricityTariffRate
object
4 properties 2 required
BadCreateOrUpdateAccountImportProcess
NoteDocument
object
1 property 1 required
HistoricalReading
object
6 properties 4 required
AccountPortfolio
object
4 properties
CustomerUserDetail
object
2 properties 2 required
ElectricityConfigurationPeriod
object
9 properties 1 required
EnergyCustomer
object
28 properties
EnergyCharge
object
10 properties 5 required
EnergyLegacySupplyAddress
object
16 properties 4 required
ErrorResponse
object
2 properties 2 required
PropertyAdministrator
object
19 properties
TaskParameters
object
3 properties
CustomerAlternativeNumber
object
1 property
BusinessDetail
object
2 properties 2 required
StandardizedError
object
3 properties 3 required
ImportEvent
object
3 properties 2 required
StandardizedValidationErrorResponse
object
3 properties 3 required
EnergyCustomerPreferences
object
9 properties
EnergySupplyCharge
object
12 properties 6 required
Complaint
object
11 properties 8 required
BadValidateAccountRequest
ElectricityRegister
object
5 properties 2 required
LineItem
object
11 properties 4 required
EnergyPrepaymentDetails
object
3 properties 3 required
DunningPath
object
2 properties 1 required
AgedDebt
object
2 properties
BaseBusiness
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edf-energy-account-import-api-openapi.yml Raw ↑

Other APIs EDF Energy publishes across the network.

EDF Kraken GraphQL API
EDF Energy Data Import API
EDF Energy External Client Healthcheck API
EDF Energy External Events API
EDF Energy Post Account Import API
EDF Energy Query API
EDF Energy V1 API
EDF Energy V2 API
Where this information came from

This is an independent, third-party profile of EDF Energy Account Import API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.