What Is a Dataset?

A dataset is a logical grouping of data attributes used for requesting a specific combination of data from the providers during data aggregation. These dataset and dataset attributes are the basic building blocks of Yodlee platform 1.1 that offer customers configuration flexibility so they can meet their needs for retrieving the data in their product flows.

Yodlee platform 1.1 has three datasets: BASIC_AGG_DATA, ACCT_PROFILE, and DOCUMENTS. Each dataset has its own list of dataset attributes that are configurable by customers during the onboarding process.

The dataset attributes are classified into three types:

  1. Basic—The primary or basic dataset attributes that are configured as the default for a customer and are included in the basic pricing.
  2. add-on—A dataset attribute that requires additional navigation to aggregate and is retrieved only on demand is considered a add-on dataset. A add-on dataset attribute can be retrieved only if the customer has subscribed to the dataset. The customer will be billed separately for every request and response.
  3. Sensitive—A dataset attribute that contains PII that can be misused for fraudulent purposes is sensitive information. To request and retrieve sensitive dataset attributes, one-time Yodlee Security Office approval is required during the customer onboarding phase.

Dataset

Dataset Attributes

Basic

Add-on

Sensitive

BASIC_AGG_DATA

ACCOUNT_DETAILS

YES

 

 

HOLDINGS

YES

 

 

STATEMENTS

YES

 

 

TRANSACTIONS

YES

 

 

ACCT_PROFILE

FULL_ACCT_NUMBER

 

YES

YES

BANK_TRANSFER_CODE

 

YES

 

HOLDER_NAME

 

YES

YES

HOLDER_DETAILS

 

YES

YES

DOCUMENTS

TAX

 

YES

YES

STATEMENTS

 

YES

YES

EBILLS

 

YES

YES

Dependent Datasets

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

Dataset Attributes

Dependent Attributes

Applicable Containers

DOCUMENT.TAX

BASIC_AGG_DATA.ACCOUNT_DETAILS

[{"container":["bank", "investment"]}]

DOCUMENT.STATEMENTS

BASIC_AGG_DATA.ACCOUNT_DETAILS

[{"container":["bank", "investment"]}]

DOCUMENT.EBILLS

BASIC_AGG_DATA.ACCOUNT_DETAILS

[{"container":["creditCard", "bill", "loan", "insurance"]}]

BASIC_AGG_DATA.STATEMENTS

[{"container":["creditCard", "bill", "loan", "insurance"]}]

BASIC_AGG_DATA.TRANSACTIONS

BASIC_AGG_DATA.ACCOUNT_DETAILS

[{"container":["bank","creditCard", "loan", "insurance", "investment"]}]

BASIC_AGG_DATA.STATEMENTS

[{"container":["creditCard"]}]

BASIC_AGG_DATA.STATEMENTS

BASIC_AGG_DATA.ACCOUNT_DETAILS

[{"container":["creditCard", "bill", "loan", "insurance"]}]

ACCT_PROFILE.HOLDER_DETAILS

ACCT_PROFILE.HOLDER_NAME

[{"container":["bank"]}]

Note: Valid containers for the dependent dataset. For the containers not configured here, no dependent dataset will be included in the request

Configuration of Dataset Attributes

In Yodlee platform 1.1, customers have the flexibility to choose among the dataset attributes they need for their product flow. During the onboarding process, customers, in collaboration with the Yodlee support team, will define their dataset configuration. These customer-defined configurations will be stored in the back end.

The customer can configure every dataset attribute as implicit or on demand:

  1. Implicit dataset—Implicit dataset attributes are retrieved when no dataset is explicitly requested by the customer in the API request.  
  2. On-demand dataset—On-demand dataset attributes can be explicitly requested in the API.

Container Configuration of Dataset Attributes

Containers should be configured for each dataset attribute. The dataset attribute is requested for a container only after getting the same configured in the back end.

Important Notes

Developers have to consider the following while working with datasets:

  • Dataset attributes and the containers provided in the API input are validated only if the customer has subscribed to them. If not, an error is returned.
  • If configured dataset attributes and containers are passed in the input, but the provider does not support some of the dataset attributes or containers, then only data relevant to that provider is returned.
  • If the provider does not support any of the requested configured dataset attributes then an error is returned.
  • If a subscription dataset attribute is passed for multiple containers, but the provider supports the attribute for only one container, the request will be honored for the supported container and the remaining requests will be ignored.

APIs Accepting Datasets as Input

The following is the list of API services that accept dataset and dataset attributes:

Endpoint URL

Input Parameter

Impact

GET providers

dataset$filter

 

Helps return all the provider sites supporting the provided datasets.

Helps search a site supporting the provided datasets.

Helps return the popular and suggested sites supporting the provided datasets

 

POST ProviderAccounts

PUT ProviderAccounts

 

 

dataset

Indicates the data to be retrieved from the provider site that corresponds to the dataset name.

If not provided, the implicit dataset attributes have to be retrieved.