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
Unique ID of the consent
ID of the Provider Account that this Consent belongs to.
Start date of the sharing window. This date is the date when the consent officially starts on the Data Holder’s end.
Date the sharing period expired or was withdrawn by the user.
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)
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.
URL of the Consent Confirmation PDF.
URL of the Consent Withdrawal PDF.
ID of the Provider that the Consumer is consenting to sharing data from
Number of seconds the data can be shared for. This is not present for Yodlee Consents!
The permissions a consent is authorised for
Any additional permissions to request from the user
Delete redundant data when consent is revoked or expires. Must be
true has no effect.
Context to link consents