CDR Onboarding Form

Welcome to Adatree! We look forward to getting you started on your CDR journey. We require some information and files to be able to configure your environments for you. As soon as you provide this information, we will set this up for you.

This guide details the information required by Adatree to onboard your organisation onto the Adatree platform. Sections labelled with REQUIRED are needed to fully configure your environment.

This information is confidential and should not be shared outside of your organisation

Adatree provides a white-labelled consent dashboard that is fully CDR compliant and customised with your branding.

To maintain brand consistency and to provide a seamless user experience, please provide us with the following brand elements so that we can style the white-label dashboard in line with your brand guidelines. If you have your brand guidelines documented on your website, please provide us with the URL to locate them or send us a copy of your brand guidelines.

We will apply branding to our whitelabel dashboard based on the below information. The branding can be changed and we can iterate based on your feedback.

Theming

Please provide your theming in JSON format by:

1. Proceeding to the theme editor in the developer portal: Adatree Theme Editor
2. Design your theme how you see fit.
3. Ensure it passes the required Accessibility Standards using the built in Accessibility test.
4. Copy the JSON from the editor using the Copy Theme JSON button.
5. Submit the JSON file with this form.

fonts

Please provide your branding font. If you have font files please provide them. Otherwise, complete the table below to select a font from Google Fonts.

Adatree requires you to delegate a subdomain to the platform where we will deploy the white-labelled consent dashboard in production.

Sandbox subdomain: The CDR Sandbox is by default configured to be yourcompanyname.nonprod.dashboard.adatree.com.au

Production subdomain: When you designated your preferred subdomain below, we will create a Name Server (NS) record within our environment and ask you to add it to your DNS configuration in your preferred DNS provider.

Examples of what you could use are:
https://dashboard.yourcompanydomain.com.au
https://cdr.yourcompanydomain.com.au
https://yourpreference.yourcompanydomain.com.au

Your consumers will be authenticated when you are using the Adatree Consent Dashboard, a Single-Page App (SPA), via a one-time Password (OTP) email based authentication provided out of the box by Adatree.

One-time Password (OTP)

Using this solution, Adatree will authenticate your consumers using email based OTP. We use AWS Cognito to provide this.

Adatree will generate a user identifier (consumerId) based on your customer’s email address and this will be populated on the consent record. You should map this consumerId record to the relevant consumer record in your own system using email address as the common key.

If you wish to control the authentication of your consumers yourself, you must bring your own OpenID Connect (OIDC) Identity Provider (IDP) that implements Authorization Code Flow with PKCE.

This must be confirmed with Sales before proceeding with your own IDP.

Provide details of your use case(s). If you intend to access a data cluster you must explain to the consumer why you need access to that data in the ‘Purpose’ column. If using the Adatree whitelabel dashboard, this will be displayed under and information icon in the consent flow next to the data cluster.

If you are using a ‘details’ cluster please note that the ‘basic’ cluster is automatically included and a combined cluster language is user as prescribed by the the Consumer Experience Standards.

We offer a few options for your integrated platform to know when a consumer has provided consent, or any updates that occur to that consent (e.g. expired or revoked).

Consent Events Endpoint

You can poll for consent event updates via the GET /consents/events endpoint. You can find further information in the Adatree Developer Portal.

Consent Notification Webhook API

If you prefer to implement a webhook, to do so securely (and similarly to how Adatree issues your integration with access described above). In that case, Adatree requires you to issue our platform with a client_id, client_secret and OAuth2.0 token endpoint where we can retrieve access tokens to be validated by your server when we send Consent update records to you via a POST request. We are happy to work with however you normally share secrets with third parties to obtain these.

The spec for the Consent Webhook API is in our developer portal at https://developer.adatree.com.au/

Sample configuration in Adatree platform.

N.B. audience is optional, some OAuth2 issuers do not support it.

"webClientConfig": {
   "clientId": "thisisyourclientid",
   "clientSecret": "thisisyourclientsecret",
   "issuerUri": "https://your.issuer.domain/",
   "tokenUri": "https://your.issuer.domain/oauth/token",
   "jwkSetUri": "https://your.issuer.domain/.well-known/jwks.json",
   "audience": "https://your.domain/",
   "resourceServer": "https://yourwebhook.domain/webhookendpoint"
}

Consent Notification Payload

Consent webhook events share the same payload as endpoint /consents/events , which can be found at https://developer.adatree.com.au/docs/api/consent/