# Adatree ADR Platform Consent API API

> Adatree ADR Platform Consent API API on Apizie: 10 endpoints (Get Consents, Create Consent, Get Consent, Update a consent's via dashboard or back channel, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/security:adatree-consent/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:adatree-consent`
- Category: Security
- Status: byok
- Source: https://adatree.com.au
- Page: https://zieapi.vercel.app/api/security/adatree-consent
- OpenAPI: https://zieapi.vercel.app/api/security/adatree-consent/openapi.json

Consent Dashboard REST APIs. This allows ADR / consumers to perform CDR consumer authorization flow with Data Holders

## Endpoints

### Get Consents
`GET https://zieapi.vercel.app/v1/security:adatree-consent/consent-get-all-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | no | consumeId, please be kindly reminded of proper encoding as Id from some IDP could have special character like '/', which need be encoded… |
| consentId | string | no | consent id |
| cdrArrangementId | string | no | cdr arrangement id |
| status | string | no |  |
| accessFrequency | string | no |  |
| postUsageAction | string | no |  |
| directMarketingAllowed | boolean | no |  |
| useCases | array | no | UseCase ids |
| dataHolderBrandId | string | no |  |
| oldestCreated | string | no | Constrain the consent with created time at or after this date/time. If absent defaults to newestCreated minus 90 days. Format is aligned… |
| newestCreated | string | no | Constrain the consent with created time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString… |
| oldestRevoked | string | no | Constrain the consent with revoked time at or after this date/time. If absent defaults to newestRevoked minus 90 days. Format is aligned… |
| newestRevoked | string | no | Constrain the consent with revoked time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString… |
| oldestSharingEndDate | string | no | Constrain the consent with sharingEndDate time at or after this date/time. If absent defaults to newestSharingEndDate minus 90 days.… |
| newestSharingEndDate | string | no | Constrain the consent with sharingEndDate time at or before this date/time. If absent defaults to today. Format is aligned to… |
| externalId | string | no | Constrain the consent by externalId |

### Create Consent
`POST https://zieapi.vercel.app/v1/security:adatree-consent/consent-record-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Adatree-Consumer-User-Agent | string | no | Mandatory for calls using a Machine token. The consumer's original User Agent header |
| Adatree-Consumer-Ip-Address | string | no | Mandatory for calls using a Machine token. The consumer's original IP address. |
| body | object | no | JSON request body |

### Get Consent
`GET https://zieapi.vercel.app/v1/security:adatree-consent/consent-get-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes |  |

### Update a consent's via dashboard or back channel
`POST https://zieapi.vercel.app/v1/security:adatree-consent/consent-update-via-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes |  |
| body | object | no | JSON request body |

### Revoke Consent
`POST https://zieapi.vercel.app/v1/security:adatree-consent/consent-revoke-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes |  |

### Get Authorization Redirect URL for a Consent
`GET https://zieapi.vercel.app/v1/security:adatree-consent/consent-authorization-redirect-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes |  |
| state | string | no | A state is generated by the consent user-agent (browser) and is used to bind the redirection response from a Data Holder with a user… |
| redirectUri | string | no | The URI to redirect to from the data holder when the consumer has finished data holder authentication. Must be from the list of redirect… |

### Retrieve consent events
`GET https://zieapi.vercel.app/v1/security:adatree-consent/get-consent-events-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oldest | string | no | Constrain the consent event result list with timestamp at or after this date/time. Format is aligned to DateTimeString common type |
| newest | string | no | Constrain the consent event result list with timestamp at or before this date/time. Format is aligned to DateTimeString common type |
| consentId | string | no | consent id |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |

### Get Data Holders
`GET https://zieapi.vercel.app/v1/security:adatree-consent/data-holders-list-available` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| softwareProductId | string | yes | The identifier of the software product registered at the ACCC registry. The list of data holders returned is the list where dynamic client… |

### Create Tokens
`POST https://zieapi.vercel.app/v1/security:adatree-consent/tokens-establish-data-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Use-cases
`GET https://zieapi.vercel.app/v1/security:adatree-consent/use-case-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| combineScopes | boolean | no | Combine scopes that can be combined according to the CDR Consumer Experience Standards |

## Example
```
curl "https://zieapi.vercel.app/v1/security:adatree-consent/consent-get-all-records" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Adatree ADR Platform Consent API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/security:adatree-consent/consent-get-all-records with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Adatree ADR Platform Consent API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Adatree ADR Platform Consent API itself also needs your own key from cdr-insights-prod.api.adatree.com.au.

### Can AI agents use the Adatree ADR Platform Consent API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:adatree-consent.

### What is the status of the Adatree ADR Platform Consent API API?
Needs your own provider key (bring your own key)