ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Add fields to Get Product Details to indicate the availability of data attributes #622

Open basiq-jon opened 7 months ago

basiq-jon commented 7 months ago

Description

When providing data under the Open Banking framework, via the Competition and Consumer (Consumer Data Right) Rules 2020 a common question asked is what data is available. The CDR specification contains many fields marked as "Optional", with the specific meaning that the data should be provided if the Data Holder has it available. It is not currently possible to tell which optional fields will be available for a given Data Holder and product.

Change Proposed

We would like to raise a change request for the API standards to add additional metadata around the availability of these optional attributes to the Get Product Details endpoint.

Adding the details of which optional fields are available for specific products to the Get Product Details will assist consumers of the Open Banking APIs to make decisions around the support for their use case under the Consumer Data Right rules. If the details of the optional field availability for each product were published in this way, users of the APIs would be able to evaluate if the data they need to deliver value to consumers under the Consumer Data Right rules is available to them, without having to test each Data Holder and product individually.