Australian Consumer Data Standards

CDR Register API

Specifications for Register endpoints made available to participants.

Government & public#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Specifications for Register endpoints made available to participants.

Endpoints 9

Register Operations

  • GETGet OpenId Provider Config/idp/.well-known/openid-configurationEndpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0…
  • GETGet JWKS/cdr-register/v1/jwksJWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in…
  • GETGet Software Statement Assertion (SSA)https://secure.api.cdr.gov.au/cdr-register/v1/:industry/data-recipients/brands/:dataRecipientBrandId/software-products/:softwareProductId/ssaGet a Software Statement Assertion (SSA) for a software product on the CDR Register to be used for Dynamic Client Registration with a Data Holder Brand.…

Register Data Holder discovery

  • GETGet Data Holder Brandshttps://secure.api.cdr.gov.au/cdr-register/v1/:industry/data-holders/brandsAllows Data Recipients to discover Data Holder Brands available in the CDR ecosystem. Obsolete versions: v1, v2.
  • GETGet Data Holder Brands Summary/cdr-register/v1/:industry/data-holders/brands/summaryEndpoint used by participants to discover public details of Data Holder Brands from the CDR Register. Obsolete versions: v1.
  • GETGet Data Holder Statuses/cdr-register/v1/:industry/data-holders/statusEndpoint used by participants to discover the statuses for Data Holders from the CDR Register. Obsolete versions: v1.

Register Data Recipient discovery

  • GETGet Software Products Statuses/cdr-register/v1/:industry/data-recipients/brands/software-products/statusEndpoint used by participants to discover the statuses for software products from the CDR Register. Obsolete versions: v1, v2.
  • GETGet Data Recipients Statuses/cdr-register/v1/:industry/data-recipients/statusEndpoint used by participants to discover the statuses for Data Recipients from the CDR Register. Obsolete versions: v1, v2.
  • GETGet Data Recipients/cdr-register/v1/:industry/data-recipientsEndpoint used by participants to discover data recipients and associated brands and software products, available in the CDR ecosystem. Obsolete versions: v2,…

API details

Base URL
https://api.cdr.gov.au
Authentication
None declared in the description
Operations
9 operations on 9 pathsGET 9
Main resources
Register Data Holder discovery 3Register Data Recipient discovery 3Register Operations 3
Description format
OpenAPI 3.0.3, API version 1.36.0

How to test the CDR Register API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CDR Register API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get OpenId Provider Config” (GET /idp/.well-known/openid-configuration), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CDR Register API?

Specifications for Register endpoints made available to participants. It is listed under Government & public and has 9 endpoints.

Who publishes the CDR Register API?

It is listed from Australian Consumer Data Standards's public API description (an OpenAPI document), not published by Australian Consumer Data Standards on Swastik Codes. Anyone who controls consumerdatastandards.gov.au can claim the profile by adding a DNS TXT record.

What is the base URL of the CDR Register API?

Requests go to https://api.cdr.gov.au. Endpoint paths are added to this base URL.

How do I authenticate with the CDR Register API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the CDR Register API have?

9 operations on 9 paths (9 GET). The largest groups are Register Data Holder discovery, Register Data Recipient discovery, Register Operations.

Is forking the CDR Register API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.