Skip to main content

Architecture Overview

This page provides a simplified view of the Open Gateway (OG) architecture and how the key participants in the CDR ecosystem interact.

Diagram​

OG architecture

Participants​

ParticipantDescription
Software ProductCustomer-built application that integrates with the Open Gateway API to initiate consent flows and retrieve CDR data on behalf of consumers. Authenticates using M2M credentials supplied by Biza during onboarding. Must expose callback endpoints to receive consent outcomes and end-of-life notifications from Open Gateway.
Open GatewayBiza's hosted CDR gateway, acting as the Accredited Data Recipient (ADR) under the CDR representative model. Manages consent, communicates with the CDR Register, and retrieves data from Data Holders.
CDR RegisterThe ACCC-operated register of accredited CDR participants. Open Gateway uses the register to verify Data Holder details and Software Statement Assertions (SSAs).
Data HoldersBanks, energy retailers, and other organisations that hold consumer data and expose CDR-compliant APIs. Open Gateway registers with them dynamically and retrieves data once a consumer has provided consent.
ConsumerThe end user who authorises data sharing. Interacts with the OG consent flow and can manage their sharing arrangements via the Consumer Dashboard.
Consumer DashboardThe consent management UI for consumers. Customers supply an identity provider (IDP) for consumer login — see OAuth2 Clients for requirements.

Open Gateway API​

The Open Gateway API is used by Software Products to initiate sharing flows, manage agreements, and retrieve CDR data. Full API reference:

Authentication for the API uses the OG Access (M2M) profile. Credentials are provisioned by Biza during the onboarding process.

Callbacks​

Open Gateway calls back to the Software Product at two points:

CallbackTriggerReference
Consent successConsumer completes the consent flow. OG calls the redirectUri supplied in the prime request, with state and agreementId query parameters.Consent Success
End-of-life webhookAn arrangement is revoked or expires. OG calls the Software Product's end-of-life webhook (batch, every 3 minutes).CDR End Of Life