Providing and Accessing Product Reference Data
For each of their public products, Data Holders (DHs) provide Product Reference Data (PRD). Accredited Data Recipients (ADRs) have access to the PRDs of Data Holders, for information including product comparison.
Access to Product Reference Data does not require authentication.
For rules on which products are eligible to be shared, see Guidance for data holders — CDR products and eligible consumers.
The Consumer Data Standards (CDS) describe Banking APIs for banking product data including:
The Get Products API responds with a list of available products, including product IDs. A call to the Get Product Detail API with a specific ID results in a banking product detail response, according to the CDS schema.
The CDS schemas for banking products begin with:
Included in BankingProductDetailV4 are subcomponents, each with its own schema. These include:
- Discounts and discount eligibility
- Deposit rates, lending rates, rate tiers, rate conditions
The Consumer Data Standards describe Energy APIs for energy plan data:
The Get Generic Plans API responds with a list of available plans, including plan IDs. A call to the Get Generic Plan Detail API. with a specified ID, results in a generic plan detail response, according to the CDS schema.
The CDS schemas for energy plans begin with:
Energy Plan Detail contains references to other schemas, including:
Customer product instantiation vs Product Reference Data
When a customer applies for a product, the product represented in the customer account becomes a specific instantiation of the general product represented in the PRD. The customer product instantation may diverge from the original, for example with specific discounts and other properties differentiating it from the general PRD. See CDS Get Products, Linkage to accounts.
The response to a Get Account Detail API call contains the details of the customer instantiation of the product. It does not reproduce the PRD representation of the product. When a customer retains an instantiation of a product, after the product is no longer offered to the public, there may be no entry in PRD corresponding to the product. A call to the Get Account Detail API still returns the customer's product instantiation. See Grandfathered Products.
There is no connection, explicit or implicit, between Get Product Details and Get Account Details. Get Account Details should be treated as an isolated endpoint. A call to Get Account Details does not rely on Get Product Details for additional information.
The instantiated account data and the Product Reference Data have similar structures and should be displayed in a similar way. However the instantiated customer account data contains only the data that applies specifically to the customer account. No other options need to be shown.
Cross-Origin Resource Sharing
When an ADR provides information from DHs in the form of a web app viewed in a browser, the ADR may use a client-side Ajax request to populate the web page. For data security, browsers prohibit making an Ajax request to a domain other than the domain hosting the web page, unless the domain holding the requested data supports Cross-Origin Resource Sharing (CORS).
DHs must provide a complete implementation of CORS, with some header values specific to the Consumer Data Standards (CDS) specification. ADRs must make Ajax requests in conformance with the CORS implementation required by CDS.
The CDS Product Comparator Demo provides an example of a web app that requires CORS to obtain Product Reference Data from the participating banks.
If a DH fails to disclose PRD when requested, the refusal and reason must be reported. Reporting requirements are specified in the CDR Rules, main section, division 9.3, subdivision 9.3.1, section 9.4 Reporting requirements. Reasons may include traffic thresholds being exceeded, or a suspected security threat. See Guidance on Product Reference Data and Reporting on Refusal to Disclose.
A data holder’s reporting obligations under rule 9.4 commence from the date they begin sharing PRD.
PRD for all product phases was required to be available from accredited ADIs from October 2020.
Testing Product Reference Data Endpoints
The CDS Product Comparator Demo provides an example of a web app that returns Product Reference Data from the PRD endpoints. If your PRD endpoints do not work with the CDS Product Comparator Demo, there may be an error in implementation or compliance. If your PRD endpoints do work with the CDS Product Comparator Demo, this does not guarantee compliance.