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

Origin Energy Account Import API

APIs for importing accounts.

Origin Energy Account Import API is one of 23 APIs that Origin 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 183 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

7 operations 7 paths 183 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.mydata.cdr.originenergy.com.au
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Origin 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 183

The contract defines 183 schemas that model the data the API accepts and returns. The most detailed are OriginAccount (69 properties), AusCustomer (36 properties), EmbeddedElecMeterPoint (28 properties), EmbeddedGasMeterPoint (26 properties). Each schema is shown below with its type and property counts.

ContractSalesRecord
object
2 properties
PartnerCommissionConfig
object
4 properties 1 required
AccountConsent
object
4 properties 2 required
ElectricitySupplyDetail
object
7 properties 1 required
StandardizedValidationErrorResponse
object
3 properties 3 required
EmbeddedElecDistributor
object
3 properties 2 required
PromotionAssignmentSchedule
object
3 properties 2 required
LatestError
object
3 properties
NewPaymentInstructionReference
object
1 property 1 required
PaymentPreferencesWithNewInstructionReferences
object
3 properties 3 required
AusConcessionCard
object
11 properties 5 required
Terms
ContributionSchemeAgreement
object
6 properties 4 required
MeterPoint
GasMeterPoint
object
17 properties 5 required
PortfolioSettings
object
4 properties
AccountBillingOptions
AusManuallyDefinedEligibilityPeriods
object
3 properties 3 required
NoteDocument
object
1 property 1 required
AusStructuredStreetAddress
object
18 properties
BadCreateOrUpdateAccountImportProcess
BillingDocumentIssuanceFrequencyTerm
object
6 properties 5 required
AusSupplyCharge
object
11 properties 6 required
GasMasterData
object
11 properties 4 required
OriginLineItem
object
14 properties 5 required
ValidateAccount
object
1 property 1 required
GasRoleAssignment
object
2 properties 2 required
CreateOrUpdateAccountImportProcess
object
2 properties 2 required
TaxAdjustmentConfiguration
object
3 properties 2 required
BadProcessAccountImportProcess
EmbeddedElecHistoricalReading
object
6 properties 5 required
CharacteristicOverrideConfiguration
object
3 properties 2 required
EmbeddedElecTransferReading
object
5 properties 4 required
GasStructuredAddress
object
14 properties 1 required
EmbeddedWaterHistoricalReading
object
4 properties 3 required
AusPaymentPlan
object
11 properties 9 required
TerminationFee
object
5 properties 3 required
SolarPPASupplyPoint
object
14 properties 2 required
PromotionAssignmentTarget
object
4 properties 2 required
Payment
object
10 properties 4 required
PaymentPreference
EmbeddedWaterConnectionPeriod
object
3 properties 2 required
CommonHouse
object
2 properties
EmbeddedElecMeterDataProvider
object
3 properties 2 required
Portfolio
CollateralRequired
object
5 properties 3 required
AusPaymentTerms
object
5 properties 2 required
AusCharge
object
9 properties 4 required
AusRichSupplyAddress
object
12 properties 3 required
Credit
object
8 properties 4 required
TaskParameters
object
3 properties
ElectricityHistoricalReading
object
7 properties 4 required
OriginLedgerRecordWithTransactions
object
9 properties
PaymentPreferencesWithExistingInstructionReferences
object
3 properties 3 required
AccountPortfolio
object
4 properties
AccountTransferStatus
object
3 properties 1 required
ProductRateOverrideSchedule
object
3 properties 1 required
TrancheTargetResidualFeeMarket
object
3 properties 3 required
PartnerCommission
object
3 properties 2 required
EmbeddedGasHistoricalReading
object
4 properties 3 required
OriginAccount
object
69 properties 1 required
AusAgreement
object
10 properties 2 required
AccountContract
object
6 properties 3 required
AusCustomer
object
36 properties
EmbeddedElecRegister
object
11 properties 9 required
PaymentInstructionCard
object
5 properties 2 required
PaymentAdequacyChange
object
12 properties 9 required
BaseBusiness
object
7 properties
AusAccountBillingOptions
object
5 properties
TimeSeriesSpecificationEligibilitySchedule
object
5 properties 4 required
AusNetEmissions
object
3 properties 3 required
AusAgreementAddOn
object
1 property 1 required
DepositAgreement
object
5 properties 2 required
AusCustomerAlternativeNumber
object
1 property
Debt
object
7 properties
EmbeddedGasMeter
object
16 properties 11 required
ExistingPaymentInstructionReference
object
2 properties 2 required
OriginStrictAccountBillingOptions
object
5 properties 4 required
EmbeddedElecMeterPoint
object
28 properties 10 required
PaysByDirectDebitTerm
object
3 properties 2 required
BusinessDetail
object
2 properties 2 required
UnmeteredGasSupplyPoint
object
17 properties 3 required
CommonStructuredAddress
object
14 properties
ProcessAccountImportProcess
object
4 properties 2 required
ImportEvent
object
3 properties 2 required
PartnerOrganisation
object
5 properties 4 required
AusPaymentPlanAdditionalInformation
object
9 properties
BasePaymentPreference
object
2 properties 2 required
ProductRateOverrideItemByVariantProfile
object
5 properties 3 required
Payments
object
3 properties 2 required
Business
IndexationOption
object
2 properties 2 required
PortfolioReference
object
2 properties 2 required
ContractMetaData
object
3 properties 2 required
TrancheTargetResidualFee
object
4 properties 3 required
CorrectivePeriodMarketConfig
object
4 properties 3 required
Metadata
object
2 properties 2 required
AusEEPAExportContractedVolumePeriod
object
5 properties 5 required
ComplaintContact
object
5 properties 5 required
AccountNotFoundError
object
1 property 1 required
EmbeddedGasTransferReading
object
3 properties 3 required
CustomerConsent
object
4 properties 2 required
Repayment
object
10 properties 4 required
AusAccountEvent
object
5 properties 5 required
EmbeddedWaterTransferReading
object
3 properties 3 required
ElectricityMeterPoint
object
18 properties 2 required
PromotionAssignmentTerm
object
3 properties 2 required
AccountReference
object
2 properties 2 required
GuaranteeOfOriginConfiguration
object
3 properties 2 required
AusPaymentInstructionBankAccount
object
5 properties 3 required
UnmeteredElectricitySupplyPoint
object
16 properties 3 required
AccountPortfolioRequiredPortfolioReference
object
4 properties 1 required
BespokeRateConfiguration
object
3 properties 2 required
ProcessAccountImportProcessCreation
object
3 properties 1 required
OriginSupplyCharge
object
11 properties 6 required
EmbeddedWaterMeterPoint
object
24 properties 8 required
CustomerPreferences
object
9 properties
ElectricityMeter
object
10 properties 1 required
PaymentSchedule
object
17 properties 2 required
AusTransaction
PropertyAdministrator
object
19 properties
OriginTransaction
AusLifeSupport
object
8 properties 4 required
AgreementIntermediaryDetails
object
2 properties 1 required
AccountAlreadyImportedResponse
object
3 properties 3 required
AccountCampaign
object
5 properties
ScheduleAccountCreation
object
2 properties 2 required
SupplyPointTaxAdjustment
object
7 properties 5 required
BadValidateAccountRequest
CustomerAlternativeNumber
object
1 property
PaymentPromise
object
3 properties 2 required
StandardizedError
object
3 properties 3 required
BusinessPortfolio
object
4 properties 1 required
BillDueDate
object
4 properties 3 required
AusLoyaltyCard
object
2 properties 2 required
ContractedVolumeConfiguration
object
3 properties 2 required
ProductRateOverrideConfiguration
object
4 properties 2 required
EffectivePeriod
object
2 properties 1 required
GasTransferReading
object
13 properties 3 required
CharacteristicOverride
object
3 properties 2 required
BespokeRateItem
object
5 properties 3 required
SalesChannelCharacteristic
object
2 properties 2 required
EmbeddedElecNMIStatusPeriod
object
3 properties 2 required
ProductRateOverrideItemByRateBand
object
3 properties 3 required
BespokeRateSchedule
object
6 properties 3 required
AusPropertyRichAddress
object
11 properties 5 required
VariantProfile
object
2 properties
AusStatement
object
15 properties 3 required
ContributionSchemePeriod
object
3 properties 2 required
ImportStatusResponse
object
6 properties 4 required
Complaint
object
11 properties 8 required
Ledger
object
2 properties 1 required
GasHistoricalReading
object
15 properties 4 required
AusEEPAExportContractedVolumeConfiguration
object
3 properties 2 required
PartnerFileAttachment
object
4 properties 4 required
ProductCharacteristic
ElectricityReading
object
5 properties 3 required
AusBillingAddress
object
11 properties 1 required
CustomerUserDetail
object
2 properties 2 required
BusinessUser
object
21 properties 1 required
AusLineItem
object
11 properties 5 required
RateGroupEligibilitySchedule
object
5 properties 4 required
ElectricityRegister
object
9 properties 1 required
DunningPath
object
2 properties 1 required
GasMeter
object
21 properties 1 required
LatePaymentFees
object
6 properties 4 required
HardshipAgreement
object
8 properties 3 required
Note
object
7 properties
EmbeddedGasMeterPoint
object
26 properties 13 required
AusPaymentInstruction
object
11 properties 4 required
EmbeddedElecMeter
object
15 properties 6 required
CommonStreet
object
3 properties
ContractedVolumePeriod
object
5 properties 5 required
CorrectivePeriod
object
3 properties 2 required
ErrorResponse
object
2 properties 2 required
RateGroupEligibilityConfiguration
object
4 properties 3 required
MinimumContractLength
object
5 properties 4 required
ContractVersion
object
2 properties 2 required
EmbeddedWaterMeter
object
16 properties 6 required
BusinessWithExistingContracts
object
9 properties
DelayerDays
object
4 properties 3 required
TaxItem
object
6 properties 5 required
AgedDebt
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Origin Energy publishes across the network.

Origin Energy Kraken GraphQL API
Origin Energy Kraken External Events
Origin Energy Kraken Authorization Server
Origin Energy Business Import API
Origin Energy Data Holder Customers API
Origin Energy Data Holder Operations API
Origin Energy Data Import API
Origin Energy Distributed Energy Resources API
Origin Energy Electricity Service Points API
Origin Energy Electricity Usage API
Origin Energy Energy Account Balances API
Origin Energy Energy Account Billing API
Where this information came from

This is an independent, third-party profile of Origin 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.