Australian Consumer Data Standards

CDR Common API

Specifications for common endpoints applicable to all data holders (except secondary data holders).

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 common endpoints applicable to all data holders (except secondary data holders).

Endpoints 4

Data Holder Customers

  • GETGet Customer/common/customerObtain basic information on the customer that has authorised the current session. <h3 id='cdr-common-api_get-customer_conventions'>Conventions</h3> In the…
  • GETGet Customer Detail/common/customer/detailObtain detailed information on the authorised customer within the current session. Obsolete versions: v1.

Data Holder Operations

  • GETGet Statushttps://tls.dh.example.com/cds-au/v1/discovery/statusObtain a health check status for the implementation.
  • GETGet Outageshttps://tls.dh.example.com/cds-au/v1/discovery/outagesObtain a list of scheduled outages for the implementation.

API details

Base URL
https://mtls.dh.example.com/cds-au/v1
Authentication
None declared in the description
Operations
4 operations on 4 pathsGET 4
Main resources
Data Holder Customers 2Data Holder Operations 2
Description format
OpenAPI 3.0.3, API version 1.36.0

How to test the CDR Common 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 Common 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 Customer” (GET /common/customer), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CDR Common API?

Specifications for common endpoints applicable to all data holders (except secondary data holders). It is listed under Government & public and has 4 endpoints.

Who publishes the CDR Common 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 Common API?

Requests go to https://mtls.dh.example.com/cds-au/v1. Endpoint paths are added to this base URL.

How do I authenticate with the CDR Common 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 Common API have?

4 operations on 4 paths (4 GET). The largest groups are Data Holder Customers, Data Holder Operations.

Is forking the CDR Common 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.