Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Working with Datasets

What is a Dataset?

A dataset is a logical grouping of data attributes used for requesting a specific set of data from the data providers during add and refresh accounts.

Yodlee API v1.1 supports four datasets: BASIC_AGG_DATA, ADVANCE_AGG_DATA, and ACCT_PROFILE. You can choose the dataset and attributes required for your business during the onboarding process.

  • Premium – Dataset attributes that require additional navigation to be aggregated.
  • Sensitive – Dataset attributes like PII are sensitive and can be misused for fraud. To subscribe to sensitive data, the audit or compliance criteria of the Yodlee Security Office must be met.

Click the appropriate dataset tab to view the attributes-related details specific to the dataset:

 

Dataset AttributesApplicable Containers/Account TypesRegionsAPI EndpointsFields
BASIC_ACCOUNT_INFObank, investment, credit card, insurance, loan, and reward.All regionsGET/accounts
GET/accounts/{accountId}
accountId
accountNumber
accountName
accountType
balance
availableBalance
ACCOUNT_DETAILSbank, investment, credit card, insurance, loan, and reward.All regionsGET/accounts
GET/accounts/{accountId}
All attributes
TRANSACTIONSbank, investment, credit card, insurance, and loanAll regionsGET transactionsAll attributes
HOLDINGSinvestment and insuranceAll regionsGET/holdingsAll attributes
STATEMENTScredit card, insurance, and loan.All regionsGET/statementsAll attributes
Dataset AttributesApplicable Containers/ Account TypesRegionsAPI EndpointsFields

INTEREST_DETAILS

loanUSGET/accounts
GET/accounts/{accountId}
interestRate
interestRateType

PAYMENT_DETAILS

loanUSGET/accounts
GET/accounts/{accountId}
payByDate
payoffAmount
outstandingBalance

COVERAGE

investment and insuranceUS and AustraliaGET/accounts
GET/accounts/{accountId}
type
startDate
endDate
amountType
limitType (Applies only to health insurance)
unitType (Applies only to health insurance)
cover
met(applicable only for health insurance)
Dataset AttributesApplicable Containers/ Account TypesRegionsAPI EndpointsFields
FULL_ACCT_NUMBERbank, investment, and loanUS, UK, Canada, Australia, and India.GET/accounts
GET/accounts/{accountId}
paymentAccountNumber
unmaskedAccountNumber
fullAccountNumber(deprecated)

BANK_TRANSFER_CODE

bank and investment.US: Routing number
India: IFSC
Australia: BSB (Bank-StateBranch)
UK: Sort code sites in the United States.
GET/accounts
GET/accounts/{accountId}
bankTransferCode
HOLDER_NAMEbank, loan, and investment.US, UK, Canada, Australia, and India.GET/accounts?include=holder,profile
GET/accounts/{accountId}?include=holder, profile
holder.name
holder.ownershipType
HOLDER_DETAILSbank and investment.US, UK, Canada, Australia, and India.GET/accounts?include=holder,profile
GET/accounts/{accountId}?include=holder, profile
GET providerAccounts/profile
holder
profile
PAYMENT_PROFILEloanUSGET/accounts, GET/accounts/{accountId}identifier
address
paymentBankTransferCode

Dependent Datasets

Certain datasets are retrieved even though they are not provided in the request. The following datasets are retrieved implicitly during the add, edit, and update/refresh account flows so the requested datasets can be retrieved successfully.

Requested DatasetImplicit DatasetApplicable Containers
ADVANCE_AGG_DATA.INTEREST_DETAILSBASIC_AGG_DATA.ACCOUNT_DETAILS BASIC_AGG_DATA.BASIC_ACCOUNT_INFOLoan
ADVANCE_AGG_DATA.PAYMENT_DETAILSBASIC_AGG_DATA.ACCOUNT_DETAILS
BASIC_AGG_DATA.BASIC_ACCOUNT_INFO
Loan
ADVANCE_AGG_DATA.COVERAGEBASIC_AGG_DATA.BASIC_ACCOUNT_INFOInvestment
Insurance
ACCT_PROFILE.FULL_ACCT_NUMBERBASIC_AGG_DATA.BASIC_ACCOUNT_INFOBank
Investment
Loan
ACCT_PROFILE.BANK_TRANSFER_CODEBASIC_AGG_DATA.BASIC_ACCOUNT_INFOBank
Investment
ACCT_PROFILE.HOLDER_DETAILSACCT_PROFILE.HOLDER_NAME
BASIC_AGG_DATA.BASIC_ACCOUNT_INFO
Bank
Investment
ACCT_PROFILE.HOLDER_NAMEBASIC_AGG_DATA.BASIC_ACCOUNT_INFOBank
Investment
ACCT_PROFILE.PAYMENT_PROFILEACCT_PROFILE.FULL_ACCT_NUMBER
BASIC_AGG_DATA.BASIC_ACCOUNT_INFO
Loan
BASIC_AGG_DATA.ACCOUNT_DETAILSBASIC_AGG_DATA.BASIC_ACCOUNT_INFOBank
Investment
Credit Card
Insurance
Realestate
Loan Reward
BASIC_AGG_DATA.HOLDINGSBASIC_AGG_DATA.BASIC_ACCOUNT_INFOInvestment
Insurance
BASIC_AGG_DATA.STATEMENTSBASIC_AGG_DATA.BASIC_ACCOUNT_INFOInsurance
Loan
Credit Card
BASIC_AGG_DATA.ACCOUNT_DETAILSCreditCard

Choose Your Dataset Attributes

  • You can choose among the dataset attributes needed for your product flow.
  • You can configure the datasets to be retrieved by default and those to be retrieved on demand.
  • Work with the Yodlee support team to define your dataset configurations and containers during the onboarding process.

Important Notes

  • Sensitive dataset attributes can be passed only if the same has been subscribed. If not, an error will be returned.
  • If a dataset attribute or a container is not supported, an error will be returned.
  • If a data provider does not support some dataset attributes, then data will be returned only for the supported dataset attributes.
  • If a subscribed dataset attribute is requested for multiple containers, but the provider supports the attribute only for one container, the request will be honored for the supported container, and the rest will be ignored.
  • If multiple subscribed dataset attributes are requested, but the provider does not support one of the dataset attributes, the request will be honored for the supported dataset, and the rest will be ignored.
  • If multiple subscribed dataset attributes are requested, but the provider does not support all the requested dataset attributes then an error will be returned.