Minimum Requirements
This page describes the minimum requirements that a customer must achieve to have a functional and compliant CDR implementation.
The Consumer Data Standards (CDS) are complex and evolving resulting at a high velocity of change for all parties. While each customer implementation is unique we describe the minimum required endpoints per sector.
All identifiers must be less than, or equal to 255 characters in length, except userId's and principalId's, which must be less than or equal to 512 characters in length.
Bankingβ
The following outlines the minimum requirements for the Banking sector.
One of the approved Authentication mechanisms:
One of the required mechanisms for revoking arrangements when a user becomes ineligible (see historical FDOs page):
- Return a
451HTTP status withurn:dio:error:cds-all:Resource/IneligibleBlockcode from Get User for ineligible users. This will result in HaaS revoking the arrangement and notifying the ADR as such. Or - Implement Get Closed Principals
All the following Data Adapter APIs (listed in suggested priority):
- Get Service Health Status (
GET /health) - Get Endpoint Meta (
GET /meta/endpoints) - Get Customer (
GET /customer/{principalId}) - Get User (
POST /login/user) (see Get User Advice and Guidance) - List Banking Accounts (
GET /banking/customer/{principalId}/account) - List Transactions (
GET /banking/customer/{principalId}/account/{accountId}/transaction) - List Payments (
GET /banking/customer/{principalId}/payment) - List Payees (
GET /banking/customer/{principalId}/payee) - Get User Notification endpoint (
POST /user/notification-info)
Additionally:
- If not using SendGrid for Notifications: Send Notification (
POST /notification) - If you offer instalment products: List Instalment Plans (
POST /banking/customer/{principalId}/account/instalment-plan) β new in HaaS Data Adapter API 2.4.0, mandatory from 9 November 2026. See List Instalment Plans. Customers without instalment products are not required to implement this endpoint.
Energyβ
The following outlines the minimum requirements for the Energy sector.
One of the approved Authentication mechanisms:
One of the required mechanisms for revoking arrangements when a user becomes ineligible (see historical FDOs page):
- Return a
451HTTP status withurn:dio:error:cds-all:Resource/IneligibleBlockcode from Get User for ineligible users. This will result in HaaS revoking the arrangement and notifying the ADR as such. Or - Implement Get Closed Principals
All the following Data Adapter APIs (listed in suggested priority):
- Get Endpoint Meta (
GET /meta/endpoints) - Get Customer (
GET /customer/{principalId}) - Get User (
POST /login/user) (see Get User Advice and Guidance) - List Energy Accounts (
GET /energy/{principalId}/account) - Retrieve FRMP Details (
POST /devices/nmi/frmp) - If not using SendGrid for Notifications: Send Notification (
POST /notification) - Get Energy Account Agreed Payment Schedule (
GET /energy/{principalId}/account/{accountId}/payment-schedule) - List Energy Account Concessions (
GET /energy/{principalId}/account/{accountId}/concession) - List Energy Account Balances (
GET /energy/{principalId}/balance) - List Energy Account Invoices (
GET /energy/{principalId}/invoice) - List Energy Account Billing Transactions (
GET /energy/{principalId}/billing)
Additionally
- Please note that there is an upcoming FDO (24Q201) for the Get User Notification endpoint (
POST /user/notification-info) to made mandatory in July. We strongly advise new holders implement this when creating their data adapter.