Data holders with Consumer Data Right (CDR) product data sharing obligations must provide a product base URI that identifies the holder path for each of its brands. This allows users of product data to request the data they need, which the data holder must then disclose via its product data request service.
Energy retailer data holders don’t have mandatory product data sharing obligations and are not required to provide a product data request service. However, if an energy retailer data holder chooses to provide a product data request service voluntarily, it will be required to provide a product base URI.
This article explains:
- what a product base URI is
- how to correctly construct URIs for API endpoints defined by the Consumer Data Standards (Standards), and
- how a data holder is expected to enter product base URI information for each of its brands in the Participant Portal.
URI structure and product base URI
To ensure consistent endpoint construction across all data holder implementations, the Consumer Data Standards define the URI structure for API endpoints as:
https://<holder-path>/cds-au/<version>/<industry>/<resource>
In this URI structure:
- the holder path is the product base URI for the relevant data holder product
- cds-au is a static identifier
- the Standards currently define the CDS major version as v1
- the resource path for banking and non-bank lending PRD APIs is: /banking/products
- the resource path for energy PRD APIs is: /energy/plans.
How to correctly construct different URIs for endpoints in the banking and non-bank lenders sectors
Get Products
The correct URL construction for a Get Products endpoint is:
{productBaseUri}/cds-au/v1/banking/products
Where:
| Component | Description |
|---|---|
| productBaseUri | Holder-defined base URI |
| /cds-au | Static CDS identifier |
| /v1 | CDS major version |
| /banking | Industry segment |
| /products | PRD resource |
|
Examples – how to construct a URI for a Get Products endpoint Example 1 Product Base URI Constructed Get Products endpoint https://api.bank.com.au/cds-au/v1/banking/products Example 2 Product Base URI https://openbanking.example.com/api Constructed Get Products endpoint https://openbanking.example.com/api/cds-au/v1/banking/products Example 3 The location of Get Products is: https://www.nbl.com.au/api/cds-au/v1/banking/products
|
Get Generic Plans
The correct URI construction for a Get Generic Plans endpoint is:
{productBaseUri}/cds-au/v1/energy/plans
Where:
| Component | Description |
|---|---|
| productBaseUri | Holder-defined base URI |
| /cds-au | Static CDS identifier |
| /v1 | CDS major version |
| /energy | Industry segment |
| /plans | PRD resource |
Relationship to other product APIs
The same URI structure applies to all PRD APIs. See below for an example:
|
Example - Get Product Detail URI: |
Entering information into the Participant Portal
The CDR Participant Portal allows data holders to publish required information on their brands on the CDR register, including the product base URI for that brand.
The product base URI information to be entered into the participant portal is only the holder-defined base path and does not include the CDS-specific URI components such as:
- cds-au
- the standards version (currently v1)
- the industry segment (banking)
- the resource path (products)
|
Examples - Correct and incorrect product base URI values Correct values These contain only the holder-defined base path:
These incorrectly include CDS path components or resources: |
More information on the topics covered in this article is available in the following resources.
- Consumer Data Standards
- PRD endpoints and public endpoint URI discovery
- CDR participant portal user guide
- CDR participant on-boarding guide
Comments
0 comments
Please sign in to leave a comment.