URL parameters

You customise the Consent Dashboard entirely through URL parameters appended when you send a user to it. All parameters are optional and can be combined in a single URL.

There are two groups:

• Prefill parameters pre-select options so the user skips steps.
• Redirect parameters control where the user is sent after they finish, or when an error occurs.

Throughout this page your-dashboard.com is a placeholder for your configured dashboard URL, e.g. your-company.dashboard.adatree.com.au.

Prefill parameters

Parameter	Name	Description
uci	Use case ID	If you have more than one use case configured on your dashboard you can send the user directly to a use case by setting the use case id parameter. You may find your use case IDs in the Management Console, provisioned to you after onboarding. Example: https://your-dashboard.com/create?uci=USE_CASE_ID
dhi	Data holder ID	If you want to send the end user directly to the consent page with a preselected data holder, you can set the data holder ID. Note that the data holder has to be associated with the use case, if not the end user will be sent to the Select data holder page. You may obtain data holder IDs from the CDR Register’s Get Data Holder Brands Summary endpoint. Example: https://your-dashboard.com/create?dhi=a1234567-123a-e456-789b-000000000000
eid	External ID	An identifier assigned by your organisation to track a specific consent within your system. This ID is attached to the consent record, enabling you to associate it with other related data across your system. Example: https://your-dashboard.com/create?eid=your-external-id
gid	Grantee ID	An identifier assigned to a Grantee, a third-party Trusted Adviser (TA) such as a broker, accountant, or financial planner, who has been authorised by a consumer (through an Accredited Data Recipient) to access their CDR data. This parameter is used exclusively within a Trusted Adviser Service Provider (TASP) consent flow. It specifies which Grantee the end user is granting consent to share their data with. If you use the TA or TASP operating model, you may find your Grantee IDs in the Management Console. Example: https://your-dashboard.com/create?gid=some-grantee-id

Redirect parameters

Adatree configures a set of default redirects for your tenant: where users go after creating a consent, after managing consents, and when an error occurs. The three redirect parameters below let you override those defaults for a single request, sending the user somewhere different depending on your needs.

Parameter	Name	Overrides the default for…
ccr	Create and update consent redirect	Called after a consent is successfully created or updated.
mcr	Manage consent redirect	Called when the user clicks Back or Done in the Manage Consent List section.
aer	Application error redirect	Called when an error is thrown in the Consent Dashboard application.

When to use an override

If you always send users to the same destination, set it as your default redirect rather than passing a parameter on every link. Your defaults are configured once for your tenant and apply automatically.

Use an override when you need more than one success or error destination. For example, if you run a marketing campaign and want users who arrive through a campaign-specific link to land on a different success page, set the ccr parameter on that link. Your default stays unchanged for everyone else.

Best practices

• Always URL encode the redirect value when appending it to the dashboard URL.
• Whenever you set ccr or mcr, also set aer so unexpected errors have somewhere to land.

The redirect values may contain placeholder tokens (such as [consentId] or [error]) that the dashboard replaces with real values before redirecting. Where you put each token (in the path or as a query parameter) is up to you. To see exactly when each redirect fires in practice, read User flows.

Create and update consent redirect (ccr)

Overrides your default create-consent redirect.

Return tokens

Token	Replaced with
[consentId]	The Consent ID of the successfully created consent.

Examples (URL encoded)

To redirect the user to https://my-app.com.au/1234-xxx-xxx-xxx-5678 (where the trailing segment is the consent ID):

https://your-dashboard.com?ccr=https%3A%2F%2Fmy-app.com.au%2F%5BconsentId%5D

To redirect the user to https://my-app.com.au/post-consent?id=1234-xxx-xxx-xxx-5678:

https://your-dashboard.com?ccr=https%3A%2F%2Fmy-app.com.au%2Fpost-consent%3Fid%3D%5BconsentId%5D

Manage consent redirect (mcr)

Overrides your default manage-consent redirect. This redirect has no return tokens.

Application error redirect (aer)

Overrides your default error redirect.

Return tokens

Token	Replaced with
[error]	An error code. See the error codes reference.
[errorDescription]	The error description.
[consentId]	The Consent ID. Returns undefined if not available when the error occurs.
[dataHolderId]	The Data Holder ID. Returns undefined if not available when the error occurs.
[dataHolderName]	The Data Holder name. Returns undefined if not available when the error occurs.

Examples (URL encoded)

https://your-dashboard.com?aer=http%3A%2F%2Fmy-app.com.au%2Fmy-error-page%2F%5Berror%5D
https://your-dashboard.com?aer=http%3A%2F%2Fmy-app.com.au%2Fmy-error-page%3Fmy-error%3D%5Berror%5D
https://your-dashboard.com?aer=http%3A%2F%2Fmy-app.com.au%2Fmy-error-page%2F%5Berror%5D%3Fmy-error-description%3D%5BerrorDescription%5D
https://your-dashboard.com?aer=http%3A%2F%2Fmy-app.com.au%2Fmy-error-page%3Fmy-error%3D%5Berror%5D%26my-error-description%3D%5BerrorDescription%5D

Combining parameters

Parameters from both groups can be combined in a single URL. For example, to send the user straight to a specific use case and data holder, and control where they land afterwards:

https://your-dashboard.com/create?uci=USE_CASE_ID&dhi=DATA_HOLDER_ID&ccr=https%3A%2F%2Fmy-app.com.au%2F%5BconsentId%5D&aer=https%3A%2F%2Fmy-app.com.au%2Ferror%2F%5Berror%5D