Skip to main content

Quick Start

This outlines the steps required to establish and agreement and then begin accessing shared CDR Data.

Overview

The following steps are required to before accessing data.

  1. Set up Agreement Template
  2. Establish an Agreement
  3. Query Data

Prerequisites

Open Gateway (OG) is required to be connected to an ecosystem to enable the sharing of data. The two currently supported ecosystems are

  • Biza Test Ecosystem
  • ACCC Register Ecosystem

Please contact Biza if you would like to enquire about how you can connect with our test ecosystem.

Connectivity to the ACCC Ecosystem is strictly controlled and requires an accreditation amongst other steps. For more information see the CDR website.

Step 1. Setup An Agreement Template

Templates control how the consent flow is shown to a consumer whom you are asking to share data. You will require a configured template to then begin the data sharing request (see Agreement Template API).

Key items

  • Templates control the data scopes that consumers can consent to. These directly control what data you can access in the CDR.
  • Templates control the duration of the sharing period.
  • Templates provide key purpose information, and should be as informative as possible to provide the Consumer with an understanding of what they are consenting to.

Step 2. Prime a Agreement

Once an Agreement Template is saved, you can then prime OG to prepare for a Consumer to establish consent (see API PrimeCDRSharingV1). You are then expected to direct the user to the given unique URL to prompt them to establish consent to share. This flow will also include the Data Holder's consent flow.

Key items

  • The consumer information is required for notifications and also data security
  • The redirect URIs allow feedback on the outcome of the Agreement establishment
  • The agreementId returned from this API call is used to access data later. It is important to remember this!
  • The redirectUri should be used to direct the user to provide consent

Step 3. Access the data

Now consent has been provided you can query data

The status of the Agreement can be queried via the Agreement API. Only ACTIVE arrangements allow access to CDR Data.