Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yodlee Consents API

Consents API

Yodlee Consents API is one of 23 APIs that Yodlee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Consents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 8 operations across 6 paths, and defines 41 schemas. It is described by OpenAPI 2.0, at version 1.1.0.

Requests are made against the base URL https://production.api.yodlee.com/ysl.

8 operations 6 paths 41 schemas 5 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.1.0
Base URL
https://production.api.yodlee.com/ysl
Terms of Service
Resource Areas
1

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 5 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Consents 8

Consents API

GET
/consents/history/count
Get Consent History Count
getConsentHistoryCount 3 params → 200400401404
GET
/consents/history
Get Consent History
getConsentHistory 5 params → 200400401404
GET
/consents/{consentId}
Get Authorization Details
getConsentDetails 1 param → 200400401404
PUT
/consents/{consentId}
Put Consent
updateConsent 2 params → 200400401404
GET
/consents/preferences
Get Consents Preferences
getConsentPreferences 1 param → 200400401404
PUT
/consents/{consentId}/renewal
Renew Consent
renewConsent 2 params → 200400401404
POST
/consents
Post Consent
createConsent 1 param → 200400401404
GET
/consents
Get Consents
getConsents 3 params → 200401404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Consent (28 properties), CreateConsent (24 properties), ConsentHistory (9 properties), Attribute (7 properties). Each schema is shown below with its type and property counts.

ConsentPreferencesResponse
object
3 properties 3 required
ConsentConfirmation
object
2 properties 2 required
Renewal
object
2 properties 2 required
Scope
object
4 properties 3 required
Consent
object
28 properties 16 required
CdrPolicy
object
2 properties 2 required
CustomDisplayData
object
5 properties 5 required
ProvidersDataset
object
2 properties
BusinessUserDetail
object
4 properties 4 required
UpdateConsent
object
3 properties
BusinessUserDetailForCreateConsent
object
1 property 1 required
TotalCount
object
1 property
ConsentHistoryResponse
object
1 property
Links
object
3 properties 3 required
UpdatedConsentResponse
object
1 property
RenewConsentResponse
object
3 properties
ThirdParty
object
2 properties 2 required
ClientTrustedAdvisor
object
3 properties 3 required
ThirdPartyADR
object
2 properties 2 required
ConsentHistoryCountResponse
object
1 property
UserDataTreatment
object
3 properties 3 required
ClientTrustedAdvisorTxt
object
1 property 1 required
CreatedConsentResponse
object
1 property
UpdateConsentRequest
object
4 properties
RenewalConsent
object
2 properties
RenewConsentRequest
object
5 properties
Attribute
object
7 properties
ConsentHistory
object
9 properties 3 required
RenewConsentPreferences
object
2 properties 2 required
ConsentResponse
object
1 property
TransactionDays
object
2 properties
DeletePreference
object
3 properties
YodleeError
object
3 properties
ConsentHistoryCount
object
1 property
Preferences
object
5 properties 4 required
DataHandling
object
2 properties 2 required
CDRInsights
object
2 properties
ContainerAttributes
object
5 properties
CDRInsightsDisclosure
object
3 properties
CreateConsentRequest
object
4 properties
CreateConsent
object
24 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yodlee-consents-api-openapi.yml Raw ↑

Other APIs Yodlee publishes across the network.

Yodlee Account Verification API
Yodlee FastLink
Yodlee Account Token API
Yodlee Accounts API
Yodlee Auth API
Yodlee Cobrand API
Yodlee Configs API
Yodlee DataExtracts API
Yodlee Derived API
Yodlee Documents API
Yodlee Holdings API
Yodlee Institutions API