Get Data Holder Brands Summary

CDS Reference

Get Data Holder Brands Summary

Current Version

v1

Deprecated Versions

Retired Versions

 

Transport

TLS

Authorisation

none

Client

data recipient

Endpoint URL

https://api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/brands/summary

Implementation Guidance

  • The industry path parameter can be used to filter the list of data holder brands:

Path

Results

Path

Results

/cdr-register/v1/banking/data-holders/brands/summary

Retrieve a list of data holder brands participating in the banking sector.

/cdr-register/v1/energy/data-holders/brands/summary

Retrieve a list of data holder brands participating in the energy sector.

/cdr-register/v1/all/data-holders/brands/summary

Retrieve a list of all data holder brands regardless of sector.

  • The dataHolderBrandId field returned in the payload may be null depending on the status of the Data Holder Brand within the Register. For e.g., a Data Holder Brand that has not yet on-boarded for consumer data sharing and is only sharing Product Data.

  • Either interimId or dataHolderBrandId will always be populated. When dataHolderBrandId is set it should be used in preference to interimId.