Introduction
Changelog
Authentication
Headers
Errors
Rate Limiting
Webhooks
CDR
OAuth 2.0
User
Devices
Addresses
Affordability
Aggregation
Bills
Budgets
Cards
Challenges
Configuration
Contacts
Events
Goals
KYC
Managed Products
Messages
Pay Day
PayID
Payments
Reports
Statements
Surveys
Calculators
Images
Users
Accounts
Transactions
Financial Passport
Status
Outages
Banking
Common
get

/cdr/consents

Get a list of all Consents for the logged in User.

The default behaviour of this API is (this will only be applied if no query params are sent in the request):

  • Always return pending, active and in_use Consents
  • Only return withdrawn and expired Consents if they were moved to that status within the last 90 days
  • Only return withdrawn and expired Consents if they have a sharing_started_at date

Authorization

oauth2 - password
oauth2 - authorizationCode
oauth2 - clientCredentials
apiKey - Authorization

Request Parameters

4 Query Parameters
6 Headers

Responses

1 Example
Schema
array[object]
$schema: http://json-schema.org/draft-04/schema#
id
integer

Unique ID of the consent

3 validations + required
provider_account_id
integer

ID of the Provider Account that this Consent belongs to.

3 validations
sharing_started_at
string

Start date of the sharing window. This date is the date when the consent officially starts on the Data Holder’s end.

1 validation
sharing_stopped_at
string

Date the sharing period expired or was withdrawn by the user.

1 validation
status
string

Consent status:

  • pending - Pending or incomplete consent where user has not successfully completed the consent process. Can be resumed
  • active - Active consent where data is being shared
  • expired - Expired consent where the sharing duration specified by the user has been exceeded
  • withdrawn - Withdrawn consent where a user has withdrawn a consent or replaced a consent with a new one
  • in_use - In use consent where a user has shared the data for a limited time but with the right of use (one time consents)
1 validation + required
authorisation_request_url
string

A URL pointing to the consented Data Holder. A client can use this URL to take the User to their bank for authorisation. This will only be returned for pending Consents.

confirmation_pdf_url
string

URL of the Consent Confirmation PDF.

withdrawal_pdf_url
string

URL of the Consent Withdrawal PDF.

provider_id
integer

ID of the Provider that the Consumer is consenting to sharing data from

4 validations
sharing_duration
number

Number of seconds the data can be shared for. This is not present for Yodlee Consents!

1 validation
permissions
array[string]

The permissions a consent is authorised for

1 validation
additional_permissions
array[string]

Any additional permissions to request from the user

1 validation
delete_redundant_data
boolean

Delete redundant data when consent is revoked or expires. Must be false, passing true has no effect.

1 validation
context
string

Context to link consents

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
Authorization