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 Business Import API

APIs for importing businesses with business contracts

Origin Energy Business 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 1 operation across 1 path, and defines 65 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.

1 operations 1 paths 65 schemas 1 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 Business 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

business_import 1

APIs for importing businesses with business contracts

POST
/v1/data-import/business/
Import business to Kraken
V1 Create Business body → 201400

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are BusinessUser (21 properties), AusStructuredStreetAddress (18 properties), BusinessWithContracts (13 properties), Address (11 properties). Each schema is shown below with its type and property counts.

ProductRateOverrideItemByRateBand
object
3 properties 3 required
BespokeRateSchedule
object
6 properties 3 required
AusPropertyRichAddress
object
11 properties 5 required
ContractSalesRecord
object
2 properties
PartnerCommissionConfig
object
4 properties 1 required
VariantProfile
object
2 properties
CorrectivePeriodMarketConfig
object
4 properties 3 required
AusEEPAExportContractedVolumePeriod
object
5 properties 5 required
ProductRateOverrideSchedule
object
3 properties 1 required
CardAndBankAccountPaymentInstruction
object
10 properties 3 required
TrancheTargetResidualFeeMarket
object
3 properties 3 required
BusinessImportProcess
object
3 properties 3 required
PromotionAssignmentSchedule
object
3 properties 2 required
PartnerCommission
object
3 properties 2 required
Address
object
11 properties 1 required
PaymentInstructionCard
object
5 properties 2 required
Terms
PromotionAssignmentTerm
object
3 properties 2 required
PortfolioSettings
object
4 properties
AusEEPAExportContractedVolumeConfiguration
object
3 properties 2 required
GuaranteeOfOriginConfiguration
object
3 properties 2 required
PartnerFileAttachment
object
4 properties 4 required
NoteDocument
object
1 property 1 required
AusStructuredStreetAddress
object
18 properties
TimeSeriesSpecificationEligibilitySchedule
object
5 properties 4 required
CustomerUserDetail
object
2 properties 2 required
BillingDocumentIssuanceFrequencyTerm
object
6 properties 5 required
BusinessUser
object
21 properties 1 required
BusinessImportProcessCreation
object
2 properties
BespokeRateConfiguration
object
3 properties 2 required
RateGroupEligibilitySchedule
object
5 properties 4 required
PaysByDirectDebitTerm
object
3 properties 2 required
ContractMetaData
object
3 properties 2 required
TaxAdjustmentConfiguration
object
3 properties 2 required
BusinessDetail
object
2 properties 2 required
BusinessWithContracts
object
13 properties 1 required
CharacteristicOverrideConfiguration
object
3 properties 2 required
LatePaymentFees
object
6 properties 4 required
Note
object
7 properties
SupplyPointTaxAdjustment
object
7 properties 5 required
CustomerAlternativeNumber
object
1 property
PartnerOrganisation
object
5 properties 4 required
BusinessContract
object
6 properties 3 required
ContractedVolumePeriod
object
5 properties 5 required
BusinessPortfolio
object
4 properties 1 required
CorrectivePeriod
object
3 properties 2 required
BillDueDate
object
4 properties 3 required
ProductRateOverrideItemByVariantProfile
object
5 properties 3 required
RateGroupEligibilityConfiguration
object
4 properties 3 required
TerminationFee
object
5 properties 3 required
PaymentInstructionBankAccount
object
4 properties 2 required
MinimumContractLength
object
5 properties 4 required
ContractedVolumeConfiguration
object
3 properties 2 required
ProductRateOverrideConfiguration
object
4 properties 2 required
ContractVersion
object
2 properties 2 required
IndexationOption
object
2 properties 2 required
EffectivePeriod
object
2 properties 1 required
PromotionAssignmentTarget
object
4 properties 2 required
CollateralRequired
object
5 properties 3 required
DelayerDays
object
4 properties 3 required
CharacteristicOverride
object
3 properties 2 required
BespokeRateItem
object
5 properties 3 required
PortfolioReference
object
2 properties 2 required
DRFError
object
Simplistic and mostly inaccurate Serializer that should represent DRF's ValidationError details
1 property
TrancheTargetResidualFee
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

origin-energy-business-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 Account 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 Business 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.