Integrate Adatree's Consent API using Konfig's TypeScript SDK

First, instantiate the SDK

It only takes a few lines of code.

index.ts


import { AdatreeConsent } from 'adatree-consent-typescript-sdk';
const adatreeConsent = new AdatreeConsent({
    bearerAuth: "BEARER_AUTH",
    // Machine to machine OAuth2 to access infosec token service
    clientId: "CLIENT_ID",
    clientSecret: "CLIENT_SECRET"
})

Then, send your first request

We made it really easy.

index.ts


// Get Consents
const getAllRecordsResponse = adatreeConsent.consent.getAllRecords({
    consumerId: "auth0%7c5fbc585628421a006e83d95d"
    consentId: "148c9187-e52b-431f-9b24-7225e75ca2be"
    cdrArrangementId: "45db4977-b12f-42bf-808d-2680eb4bd366"
    status: "ACTIVE"
    accessFrequency: "ONCE_OFF"
    postUsageAction: "DELETION"
    dataHolderBrandId: "55b3299a-3e50-48a2-a190-cca263ccaba5"
    oldestCreated: "1997-01-12T15:43:00.121Z"
    newestCreated: "1997-01-12T15:43:00.121Z"
    oldestRevoked: "1997-01-12T15:43:00.121Z"
    newestRevoked: "1997-01-12T15:43:00.121Z"
    oldestSharingEndDate: "1997-01-12T15:43:00.121Z"
    newestSharingEndDate: "1997-01-12T15:43:00.121Z"
    externalId: "an-external-id"
})

Enjoy a buttery smooth developer experience with 10 SDK methods

Parameter

consumerIdstring

consumeId, please be kindly reminded of proper encoding as Id from some IDP could have special character like '|', which need be encoded as '%7c'.
consumerId should only be used with machine token, otherwise it will be deemed BAD_REQUEST

consentIdstring

consent id

cdrArrangementIdstring

cdr arrangement id

statusstring

accessFrequencystring

postUsageActionstring

directMarketingAllowedboolean

useCasesarray

UseCase ids

dataHolderBrandIdstring

oldestCreatedstring

Constrain the consent with created time at or after this date/time. If absent defaults to newestCreated minus 90 days. Format is aligned to DateTimeString common type

newestCreatedstring

Constrain the consent with created time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type

oldestRevokedstring

Constrain the consent with revoked time at or after this date/time. If absent defaults to newestRevoked minus 90 days. Format is aligned to DateTimeString common type

newestRevokedstring

Constrain the consent with revoked time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type

oldestSharingEndDatestring

Constrain the consent with sharingEndDate time at or after this date/time. If absent defaults to newestSharingEndDate minus 90 days. Format is aligned to DateTimeString common type

newestSharingEndDatestring

Constrain the consent with sharingEndDate time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type

externalIdstring

Constrain the consent by externalId

Response

200

401

403

429

Endpoint

get

/consents

Parameter

adatreeConsumerUserAgentstring

Mandatory for calls using a Machine token. The consumer's original User Agent header

adatreeConsumerIpAddressstring

Mandatory for calls using a Machine token. The consumer's original IP address.

consumerEmailstring

sharingEndDatestringrequired

dataHolderBrandIdstringrequired

useCaseIdstringrequired

postUsageActionstring

directMarketingAllowedboolean

externalIdstring

consumerIdstring

granteeobject

customDataobject

Response

200

401

403

422

429

Endpoint

post

/consents

Parameter

consentIdstringrequired

Response

200

default response

401

403

404

429

Endpoint

delete

/consents/{consentId}

Parameter

consentIdstringrequired

Response

200

401

403

404

429

Endpoint

get

/consents/{consentId}

Parameter

consentIdstringrequired

Response

200

consent successfully updated

401

403

404

429

Endpoint

patch

/consents/{consentId}

Parameter

consentIdstringrequired

statestring

A state is generated by the consent user-agent (https://developer.adatree.com.au/docs/api/consent/ and is used to bind the redirection response from a Data Holder with a user session as per https://openid.net/specs/openid-financial-api-part-1-1_0-final.html#public-client. It is sent in the authentication request, and is then also included redirect from the ADH to the ADR. This allows the ADR client application prevent CSRF attacks. Must be unique per authorization request.

redirectUristring

The URI to redirect to from the data holder when the consumer has finished data holder authentication. Must be from the list of redirect URIs configured at the ACCC register.

Response

200

Authorization link for a Consent

401

403

404

409

429

Endpoint

get

/consents/{consentId}/authorization

How Konfig Works

Konfig collects APIs and automatically generates SDKs so you can focus on building your application.

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.

Generates AI-Augmented SDKs from openapi-examples

Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.

Publishes to standard package managers

We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.

About Adatree

Adatree is a CDR technology intermediary. What does that mean? Simply put, we're the poles and wires connecting Banking, Finance, Energy and Telecommunications with Open Data. Our platform is ready for implementation with out-of-the-box functionality to have you connected to compliant data within a matter of weeks. The new age of data regulations are changing the way FinTech operates. Adatree is your on-ramp to stay plugged into the digital economy. We work with organisations of all sizes and sectors to provide turnkey solutions. We've built a world-class CDR intermediary platform that is the most robust and flexible in market, ready to scale for any Open Data use case. If the scores of awards don't prove it, our list of satisfied clients ought to. When you work with Adatree you're working with genuine CDR experts. We live and breathe this stuff, and strive to make it easy for other businesses to access consumer data with confidence. We'll help you: - Determine which CDR access model is best for your organisation - Implement our fully-compliant white-labelled consent dashboard, tailored to your unique business needs - Meet all compliance and legislative requirements including authentication and consent - Leverage the full CDR ecosystem with every available API - Accelerate your time-to-market to weeks (not months!) with our proven streamlined integration process - Maintain consistent and secure connections to the Consumer Data Right network We know the Consumer Data Right back-to-front and promise to walk you through every stage of the journey. Ready to take the first step? Reach out to our team today: https://www.adatree.com.au/contact

Easily Integrate
Adatree's Consent API using Konfig's TypeScript SDK

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

First, instantiate the SDK

Then, send your first request

Enjoy a buttery smooth developer experience with 10 SDK methods

Get Consents

Parameter

Response

Endpoint

Create Consent

Parameter

Response

Endpoint

Revoke Consent

Parameter

Response

Endpoint

Get Consent

Parameter

Response

Endpoint

Update a consent's via dashboard or back channel

Parameter

Response

Endpoint

Get Authorization Redirect URL for a Consent

Parameter

Response

Endpoint

How Konfig Works

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

Generates AI-Augmented SDKs from openapi-examples

Publishes to standard package managers

About Adatree

Keywords

Start integrating Adatree's Consent API with Konfig

Easily Integrate Adatree's Consent API using Konfig's TypeScript SDK

Need a TypeScript SDK for Adatree's Consent API?

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

First, instantiate the SDK

Then, send your first request

Enjoy a buttery smooth developer experience with 10 SDK methods

Get Consents

Parameter

Response

Endpoint

Create Consent

Parameter

Response

Endpoint

Revoke Consent

Parameter

Response

Endpoint

Get Consent

Parameter

Response

Endpoint

Update a consent's via dashboard or back channel

Parameter

Response

Endpoint

Get Authorization Redirect URL for a Consent

Parameter

Response

Endpoint

How Konfig Works

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

Generates AI-Augmented SDKs from openapi-examples

Publishes to standard package managers

About Adatree

Keywords

Start integrating Adatree's Consent API with Konfig

Easily Integrate
Adatree's Consent API using Konfig's TypeScript SDK