Consent Resource
Entity: consent
Attribute Name | Type | Description | Endpoints |
---|---|---|---|
consentId | long | The unique identifier for each user-consent. | POST consents GET consents PUT consents/{consentId} GET consents/{consentId} |
title | string | Text that will be displayed as the title of the consent. | POST consents GET consents |
titleBody | string | Text that will be displayed as the titlebody of the consent data cluster. | POST consents GET consents |
scope | entity[] | Mapped to unit of a data element that is being retrieved. This is as per the granularity of data cluster defined by Open Banking standards. | POST consents GET consents |
expirationDate | date | The date the refresh token expires and the customer has to renew the access. | POST consents GET consents |
dataAccessFrequency | string | The frequency of data access that has to be defined as per the Open Banking standards. Valid Value: Data Access Frequency |
POST consents GET consents |
consentStatus | string | The status will be used to control the flow of consent. Valid Value: Consent Status |
POST consents GET consents |
providerAccountId | long | The unique identifier for the provider account resource associated with a consent. The ID is created during the account addition process. | POST consents GET consents |
providerId | long | The unique identifier for the provider resource associated with the consent. This ID indicates the provider for which the provider account ID is generated by the user. | POST consents GET consents PUT consents/{consentId} |
authorizationUrl | string | Based on the user-permission shared, Yodlee will provide the bank's authorization URL to which the user has to be redirected. | PUT consents/{consentId} |
Entity: scope
Enums: Consent Status
Enums: Data Access Frequency
Data Access Frequency | Description |
---|---|
ONE_TIME | The user has to provide data access permissions only once, and there is no need to renew it. |
RECURRING | Once the user has provided data access permission, the user has to renew the consent at regular intervals. The default data access frequency. |