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, ACCT_PROFILE, and DOCUMENT. You can choose the dataset and attributes required for your business, during the onboarding process.
- Premium – Dataset attributes that require additional navigation to aggregate.
- Sensitive – Dataset attributes like PII are sensitive and can be misused for fraudulent purposes. To subscribe to sensitive data the audit or compliance criteria of the Yodlee Security Office have to be met.
Click the appropriate dataset tab to view the attributes-related details specfic to the dataset:
| Dataset Attributes | Applicable Containers/ Account Types | Regions | API Endpoints | Fields |
|---|---|---|---|---|
| BASIC_ACCOUNT_INFO | bank, investment, credit card, insurance, loan, and reward. | All regions | GET/accounts GET/accounts/{accountId} |
accountId accountNumber accountName accountType balance availableBalance |
| ACCOUNT_DETAILS | bank, investment, credit card, insurance, loan, and reward. | All regions | GET/accounts GET/accounts/{accountId} |
All attributes |
| TRANSACTIONS | bank, investment, credit card, insurance, and loan | All regions | GET transactions | All attributes |
| HOLDINGS | investment and insurance | All regions | GET/holdings | All attributes |
| STATEMENTS | credit card, insurance, and loan. | All regions | GET/statements | All attributes |
| Dataset Attributes | Applicable Containers/ Account Types | Regions | API Endpoints | Fields |
|---|---|---|---|---|
|
INTEREST_DETAILS |
loan | US | GET/accounts GET/accounts/{accountId} |
interestRate interestRateType |
|
PAYMENT_DETAILS |
loan | US | GET/accounts GET/accounts/{accountId} |
payByDate payoffAmount outstandingBalance |
|
COVERAGE |
investment and insurance | US and Australia | GET/accounts GET/accounts/{accountId} |
type startDate endDate amountType limitType (applicable only for health insurance) unitType (applicable only for health insurance) cover met(applicable only for health insurance) |
| Dataset Attributes | Applicable Containers/ Account Types | Regions | API Endpoints | Fields |
|---|---|---|---|---|
| FULL_ACCT_NUMBER | bank, investment, and loan | US, 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_NAME | bank, 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_DETAILS | bank and investment. | US, UK, Canada, Australia, and India. |
GET/accounts?include=holder,profile GET providerAccounts/profile |
holder profile |
| PAYMENT_PROFILE | loan | US | GET/accounts, GET/accounts/{accountId} | identifier address paymentBankTransferCode |
| Dataset Attributes | Applicable Containers/ Account Types | Regions | API Endpoints | Fields |
|---|---|---|---|---|
| TAX | bank, investment, and loan. | US and India. | GET documents?docType=TAX GET documents/{documentId} |
All attributes |
|
STATEMENTS |
bank and investment | All regions | GET documents?docType=STMT GET documents/{documentId} |
All attributes |
| EBILLS | credit card, loan, and insurance. |
US. | GET documents?docType=EBILL GET documents/{documentId} |
All attributes |
Dependent Datasets
Certain datasets are retrieved even though they are not provided in the request. Following datasets are retrieved implicitly during the add, edit, and update/refresh account flows so the requested datasets can be retrieved successfully.
|
Implicit Dataset |
Applicable Containers |
|
|---|---|---|
| ADVANCE_AGG_DATA.INTEREST_DETAILS | BASIC_AGG_DATA.ACCOUNT_DETAILS BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Loan |
| ADVANCE_AGG_DATA.PAYMENT_DETAILS | BASIC_AGG_DATA.ACCOUNT_DETAILS BASIC_AGG_DATA.BASIC_ACCOUNT_INFO |
Loan |
| ADVANCE_AGG_DATA.COVERAGE | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Investment Insurance |
| ACCT_PROFILE.FULL_ACCT_NUMBER | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment Loan |
| ACCT_PROFILE.BANK_TRANSFER_CODE | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment |
| ACCT_PROFILE.HOLDER_DETAILS | ACCT_PROFILE.HOLDER_NAME BASIC_AGG_DATA.BASIC_ACCOUNT_INFO |
Bank Investment |
| ACCT_PROFILE.HOLDER_NAME | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment |
| ACCT_PROFILE.PAYMENT_PROFILE | ACCT_PROFILE.FULL_ACCT_NUMBER BASIC_AGG_DATA.BASIC_ACCOUNT_INFO |
Loan |
| BASIC_AGG_DATA.ACCOUNT_DETAILS | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment Credit Card Insurance Realestate Loan Reward |
| BASIC_AGG_DATA.HOLDINGS | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Investment Insurance |
| BASIC_AGG_DATA.STATEMENTS | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Insurance Loan Credit Card |
| BASIC_AGG_DATA.ACCOUNT_DETAILS | CreditCard | |
| DOCUMENT.EBILLS | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO BASIC_AGG_DATA.STATEMENTS BASIC_AGG_DATA.ACCOUNT_DETAILS |
Credit Card Loan Insurance |
| DOCUMENT.STATEMENTS | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment |
| DOCUMENT.TAX | BASIC_AGG_DATA.BASIC_ACCOUNT_INFO | Bank Investment Loan |
Choose Your Dataset Attributes
- You have the flexibility to choose among the dataset attributes needed for your product flow.
- You can configure the datasets to be retrieved by default and the datasets to be retrieved on demand.
- During the onboarding process, work with the Yodlee support team to define your dataset configurations and containers.
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 of the dataset attributes, then data only for the supported dataset attributes will be returned.
- 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.