HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
APIs
These docs are for v2023.11. Click to read the latest docs for v2025.03.01.

Gets the available customer consents.

Obtain information about the methods and parties a customer can given their approval to allow their data to be shared with.
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
500 | 90061 | SystemFailureFault | System Failure, please try again later
404 | 90024 | InvalidLocaleFault | Locale provided is incorrect

Query Params
string
Defaults to ALL

If not supplied, all consent items will be returned. If supplied, specifies whether to return only mandatory or all consent items.

Headers
uuid

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

uuid

The ID of the user requesting the operation. This will be automatically generated during the authentication process.

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Language
Choose an example:
application/json