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}
renewedDateTime	string	The date and time when the consent was renewed. Note: This field is primarily available for AU OB sites, and for other regions/providers, it will depend on data availability.	GET consents

Entity: scope

Attribute Name	Type	Description	Endpoints
scopeId	string	A unique identifier of the data cluster scope.	POST consents GET consents
title	string	Text that will be displayed as the title of the particular scope.	POST consents GET consents
titleBody	string	Text that will be displayed as the titleBody of the particular scope.	POST consents GET consents
datasetAttribute	string[]	The corresponding dataset attribute.	POST consents GET consents

Attribute Name	Type	Description	Endpoints
eventDateTime	date	The history logged time.	GET /consents/history
expirationDateTime	string	The consent expiration date. This field does not apply to US Open Banking.	GET /consents/history
userDataPurge	integer	The applicable datapurge value for the consent as per the AU OB onboarding model and user-selected Delete my data instead selection. This field applies only to AU Open Banking.	GET /consents/history
deidentificationPreference	boolean	The data deidentification preference value of the consent.	GET /consents/history
startDateTime	date	The consent start date.	GET /consents/history
consentStatus	string	The status of the consent which will be used to control the flow of consent. Valid Value: Consent Status	GET /consents/history POST consents GET consents
revokedDateTime	date	The date the consent was revoked.	GET /consents/history
consentCollectionPeriod	integer	The consent duration period selected by the user for recurring consents during the new account addition or consent renewal flow. This field applies only to AU Open Banking	GET /consents/history
renewedDateTime	string	The date and time when the consent was renewed. Note: This field is primarily available for AU OB sites, and for other regions/providers, it will depend on data availability.	GET /consents/history

Enums: Consent Status

Consent Status	Description
PENDING	The user is yet to authorize or authorise the consent.
ACTIVE	The user has authorized or authorised the consent.
REVOKED	The user has explicitly revoked the access of consent. In the case of US Open Banking, the consent status is REVOKED when the provider account is deleted.
EXPIRED	The consent has expired as it ran out of its expiry period.

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.

See also Institutions data page
See also Provider Accounts data page