Module yodlee

ballerinax/yodlee Ballerina library

1.5.1

Overview

This is a generated connector for Yodlee Core API v1.1.0 OpenAPI specification.

Envestnet | Yodlee API (“Yodlee API”) is a flexible RESTful API that allows developers to access personal financial data from the Envestnet | Yodlee financial data platform that can be used to develop various financial management applications. Yodlee API 1.1 is designed to work with FastLink 3.0.

Prerequisites

Create a Yodlee account
Obtain tokens
- Use this guide to obtain the OAuth tokens related to your account.

Clients

yodlee: Client

Isolated

This is a generated connector for Yodlee Core API v1.1.0 OpenAPI specification Envestnet | Yodlee API (“Yodlee API”) is a flexible RESTful API that allows developers to access personal financial data from the Envestnet | Yodlee financial data platform that can be used to develop various financial management applications. Yodlee API 1.1 is designed to work with FastLink 3.0.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Yodlee account and obtain OAuth tokens following this guide.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

getAllAccounts

Isolated FunctionRemote Function

function getAllAccounts(string? accountId, string? container, string? include, string? providerAccountId, string? requestId, string? status) returns AccountResponse|error

Get Accounts

Parameters

accountId string? (default ()) - Comma separated accountIds.

container string? (default ()) - bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities

include string? (default ()) - profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

providerAccountId string? (default ()) - Comma separated providerAccountIds.

requestId string? (default ()) - The unique identifier that returns contextual data

status string? (default ()) - ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED

Return Type

AccountResponse|error - OK

createManualAccount

Isolated FunctionRemote Function

function createManualAccount(CreateAccountRequest payload) returns CreatedAccountResponse|error

Add Manual Account

Parameters

payload CreateAccountRequest - accountParam

Return Type

CreatedAccountResponse|error - OK

evaluateAddress

Isolated FunctionRemote Function

function evaluateAddress(EvaluateAddressRequest payload) returns EvaluateAddressResponse|error

Evaluate Address

Parameters

payload EvaluateAddressRequest - addressParam

Return Type

EvaluateAddressResponse|error - OK

getHistoricalBalances

Isolated FunctionRemote Function

function getHistoricalBalances(string? accountId, string? fromDate, boolean? includeCF, string? interval, int? skip, string? toDate, int? top) returns AccountHistoricalBalancesResponse|error

Get Historical Balances

Parameters

accountId string? (default ()) - accountId

fromDate string? (default ()) - from date for balance retrieval (YYYY-MM-DD)

includeCF boolean? (default ()) - Consider carry forward logic for missing balances

interval string? (default ()) - D-daily, W-weekly or M-monthly

skip int? (default ()) - skip (Min 0)

toDate string? (default ()) - toDate for balance retrieval (YYYY-MM-DD)

top int? (default ()) - top (Max 500)

Return Type

AccountHistoricalBalancesResponse|error - OK

getAccount

Isolated FunctionRemote Function

function getAccount(int accountId, string? include) returns AccountResponse|error

Get Account Details

Parameters

accountId int - accountId

include string? (default ()) - profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

Return Type

AccountResponse|error - OK

updateAccount

Isolated FunctionRemote Function

function updateAccount(int accountId, UpdateAccountRequest payload) returns Response|error

Update Account

Parameters

accountId int - accountId

payload UpdateAccountRequest - accountRequest

Return Type

Response|error - OK

deleteAccount

Isolated FunctionRemote Function

function deleteAccount(int accountId) returns Response|error

Delete Account

Parameters

accountId int - accountId

Return Type

Response|error - OK

getApiKeys

Isolated FunctionRemote Function

function getApiKeys() returns ApiKeyResponse|error

Get API Keys

Return Type

ApiKeyResponse|error - OK

generateApiKey

Isolated FunctionRemote Function

function generateApiKey(ApiKeyRequest payload) returns ApiKeyResponse|error

Generate API Key

Parameters

payload ApiKeyRequest - apiKeyRequest

Return Type

ApiKeyResponse|error - OK

deleteApiKey

Isolated FunctionRemote Function

function deleteApiKey(string 'key) returns Response|error

Delete API Key

Parameters

'key string - key

Return Type

Response|error - OK

generateAccessToken

Isolated FunctionRemote Function

function generateAccessToken() returns ClientCredentialTokenResponse|error

Generate Access Token

Return Type

ClientCredentialTokenResponse|error - OK

deleteToken

Isolated FunctionRemote Function

function deleteToken() returns Response|error

Delete Token

Return Type

Response|error - No Content

getSubscribedEvents

DeprecatedIsolated FunctionRemote Function

function getSubscribedEvents(string? eventName) returns CobrandNotificationResponse|error

Get Subscribed Events

Parameters

eventName string? (default ()) - eventName

Return Type

CobrandNotificationResponse|error - OK
Deprecated

updateSubscribedEvent

DeprecatedIsolated FunctionRemote Function

function updateSubscribedEvent(string eventName, UpdateCobrandNotificationEventRequest payload) returns Response|error

Update Subscription

Parameters

eventName string - eventName

payload UpdateCobrandNotificationEventRequest - eventRequest

Return Type

Response|error - OK
Deprecated

createSubscriptionEvent

DeprecatedIsolated FunctionRemote Function

function createSubscriptionEvent(string eventName, CreateCobrandNotificationEventRequest payload) returns Response|error

Subscribe Event

Parameters

eventName string - eventName

payload CreateCobrandNotificationEventRequest - eventRequest

Return Type

Response|error - OK
Deprecated

deleteSubscribedEvent

DeprecatedIsolated FunctionRemote Function

function deleteSubscribedEvent(string eventName) returns Response|error

Delete Subscription

Parameters

eventName string - eventName

Return Type

Response|error - OK
Deprecated

cobrandLogin

Isolated FunctionRemote Function

function cobrandLogin(CobrandLoginRequest payload) returns CobrandLoginResponse|error

Cobrand Login

Parameters

payload CobrandLoginRequest - cobrandLoginRequest

Return Type

CobrandLoginResponse|error - OK

cobrandLogout

Isolated FunctionRemote Function

function cobrandLogout() returns Response|error

Cobrand Logout

Return Type

Response|error - Logout successful

getPublicKey

DeprecatedIsolated FunctionRemote Function

function getPublicKey() returns CobrandPublicKeyResponse|error

Get Public Key

Return Type

CobrandPublicKeyResponse|error - OK
Deprecated

getSubscribedNotificationEvents

Isolated FunctionRemote Function

function getSubscribedNotificationEvents(string? eventName) returns ConfigsNotificationResponse|error

Get Subscribed Notification Events

Parameters

eventName string? (default ()) - eventName

Return Type

ConfigsNotificationResponse|error - OK

updateSubscribedNotificationEvent

Isolated FunctionRemote Function

function updateSubscribedNotificationEvent(string eventName, UpdateConfigsNotificationEventRequest payload) returns Response|error

Update Notification Subscription

Parameters

eventName string - eventName

payload UpdateConfigsNotificationEventRequest - eventRequest

Return Type

Response|error - OK

createSubscriptionNotificationEvent

Isolated FunctionRemote Function

function createSubscriptionNotificationEvent(string eventName, CreateConfigsNotificationEventRequest payload) returns Response|error

Subscribe For Notification Event

Parameters

eventName string - eventName

payload CreateConfigsNotificationEventRequest - eventRequest

Return Type

Response|error - OK

deleteSubscribedNotificationEvent

Isolated FunctionRemote Function

function deleteSubscribedNotificationEvent(string eventName) returns Response|error

Delete Notification Subscription

Parameters

eventName string - eventName

Return Type

Response|error - OK

getPublicEncryptionKey

Isolated FunctionRemote Function

function getPublicEncryptionKey() returns ConfigsPublicKeyResponse|error

Get Public Key

Return Type

ConfigsPublicKeyResponse|error - OK

getDataExtractsEvents

Isolated FunctionRemote Function

function getDataExtractsEvents(string eventName, string fromDate, string toDate) returns DataExtractsEventResponse|error

Get Events

Parameters

eventName string - Event Name

fromDate string - From DateTime (YYYY-MM-DDThh:mm:ssZ)

toDate string - To DateTime (YYYY-MM-DDThh:mm:ssZ)

Return Type

DataExtractsEventResponse|error - OK

getDataExtractsUserData

Isolated FunctionRemote Function

function getDataExtractsUserData(string fromDate, string loginName, string toDate) returns DataExtractsUserDataResponse|error

Get userData

Parameters

fromDate string - From DateTime (YYYY-MM-DDThh:mm:ssZ)

loginName string - Login Name

toDate string - To DateTime (YYYY-MM-DDThh:mm:ssZ)

Return Type

DataExtractsUserDataResponse|error - OK

getHoldingSummary

Isolated FunctionRemote Function

function getHoldingSummary(string? accountIds, string? classificationType, string? include) returns DerivedHoldingSummaryResponse|error

Get Holding Summary

Parameters

accountIds string? (default ()) - Comma separated accountIds

classificationType string? (default ()) - e.g. Country, Sector, etc.

include string? (default ()) - details

Return Type

DerivedHoldingSummaryResponse|error - OK

getNetworth

Isolated FunctionRemote Function

function getNetworth(string? accountIds, string? container, string? fromDate, string? include, string? interval, int? skip, string? toDate, int? top) returns DerivedNetworthResponse|error

Get Networth Summary

Parameters

accountIds string? (default ()) - comma separated accountIds

container string? (default ()) - bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities

fromDate string? (default ()) - from date for balance retrieval (YYYY-MM-DD)

include string? (default ()) - details

interval string? (default ()) - D-daily, W-weekly or M-monthly

skip int? (default ()) - skip (Min 0)

toDate string? (default ()) - toDate for balance retrieval (YYYY-MM-DD)

top int? (default ()) - top (Max 500)

Return Type

DerivedNetworthResponse|error - OK

getTransactionSummary

Isolated FunctionRemote Function

function getTransactionSummary(string groupBy, string? accountId, string? categoryId, string? categoryType, string? fromDate, string? include, boolean? includeUserCategory, string? interval, string? toDate) returns DerivedTransactionSummaryResponse|error

Get Transaction Summary

Parameters

groupBy string - CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY

accountId string? (default ()) - comma separated account Ids

categoryId string? (default ()) - comma separated categoryIds

categoryType string? (default ()) - INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION

fromDate string? (default ()) - YYYY-MM-DD format

include string? (default ()) - details

includeUserCategory boolean? (default ()) - TRUE/FALSE

interval string? (default ()) - D-daily, W-weekly, M-mothly or Y-yearly

toDate string? (default ()) - YYYY-MM-DD format

Return Type

DerivedTransactionSummaryResponse|error - OK

getDocuments

Isolated FunctionRemote Function

function getDocuments(string? keyword, string? accountId, string? docType, string? fromDate, string? toDate) returns DocumentResponse|error

Get Documents

Parameters

keyword string? (default ()) - The string used to search a document by its name.

accountId string? (default ()) - The unique identifier of an account. Retrieve documents for a given accountId.

docType string? (default ()) - Accepts only one of the following valid document types: STMT, TAX, and EBILL.

fromDate string? (default ()) - The date from which documents have to be retrieved.

toDate string? (default ()) - The date to which documents have to be retrieved.

Return Type

DocumentResponse|error - OK

downloadDocument

Isolated FunctionRemote Function

function downloadDocument(string documentId) returns DocumentDownloadResponse|error

Download a Document

Parameters

documentId string - documentId

Return Type

DocumentDownloadResponse|error - OK

deleteDocument

Isolated FunctionRemote Function

function deleteDocument(string documentId) returns Response|error

Delete Document

Parameters

documentId string - documentId

Return Type

Response|error - OK

getHoldings

Isolated FunctionRemote Function

function getHoldings(string? accountId, string? assetclassificationClassificationtype, string? classificationValue, string? include, string? providerAccountId) returns HoldingResponse|error

Get Holdings

Parameters

accountId string? (default ()) - Comma separated accountId

assetclassificationClassificationtype string? (default ()) - e.g. Country, Sector, etc.

classificationValue string? (default ()) - e.g. US

include string? (default ()) - assetClassification

providerAccountId string? (default ()) - providerAccountId

Return Type

HoldingResponse|error - OK

getAssetClassificationList

Isolated FunctionRemote Function

function getAssetClassificationList() returns HoldingAssetClassificationListResponse|error

Get Asset Classification List

Return Type

HoldingAssetClassificationListResponse|error - OK

getHoldingTypeList

Isolated FunctionRemote Function

function getHoldingTypeList() returns HoldingTypeListResponse|error

Get Holding Type List

Return Type

HoldingTypeListResponse|error - OK

getSecurities

Isolated FunctionRemote Function

function getSecurities(string? holdingId) returns HoldingSecuritiesResponse|error

Get Security Details

Parameters

holdingId string? (default ()) - Comma separated holdingId

Return Type

HoldingSecuritiesResponse|error - OK

getAllProviderAccounts

Isolated FunctionRemote Function

function getAllProviderAccounts(string? include, string? providerIds) returns ProviderAccountResponse|error

Get Provider Accounts

Parameters

include string? (default ()) - include

providerIds string? (default ()) - Comma separated providerIds.

Return Type

ProviderAccountResponse|error - OK

editCredentialsOrRefreshProviderAccount

Isolated FunctionRemote Function

function editCredentialsOrRefreshProviderAccount(string providerAccountIds, ProviderAccountRequest payload) returns UpdatedProviderAccountResponse|error

Update Account

Parameters

providerAccountIds string - comma separated providerAccountIds

payload ProviderAccountRequest - loginForm or field entity

Return Type

UpdatedProviderAccountResponse|error - OK

getProviderAccountProfiles

Isolated FunctionRemote Function

function getProviderAccountProfiles(string? providerAccountId) returns ProviderAccountUserProfileResponse|error

Get User Profile Details

Parameters

providerAccountId string? (default ()) - Comma separated providerAccountIds.

Return Type

ProviderAccountUserProfileResponse|error - OK

getProviderAccount

Isolated FunctionRemote Function

function getProviderAccount(int providerAccountId, string? include, string? requestId) returns ProviderAccountDetailResponse|error

Get Provider Account Details

Parameters

providerAccountId int - providerAccountId

include string? (default ()) - include credentials,questions

requestId string? (default ()) - The unique identifier for the request that returns contextual data

Return Type

ProviderAccountDetailResponse|error - OK

deleteProviderAccount

Isolated FunctionRemote Function

function deleteProviderAccount(int providerAccountId) returns Response|error

Delete Provider Account

Parameters

providerAccountId int - providerAccountId

Return Type

Response|error - OK

updatePreferences

Isolated FunctionRemote Function

function updatePreferences(int providerAccountId, ProviderAccountPreferencesRequest payload) returns Response|error

Update Preferences

Parameters

providerAccountId int - providerAccountId

payload ProviderAccountPreferencesRequest - preferences

Return Type

Response|error - OK

getAllProviders

Isolated FunctionRemote Function

function getAllProviders(string? capability, string? datasetFilter, string? fullAccountNumberFields, int? institutionId, string? name, string? priority, string? providerId, int? skip, int? top) returns ProviderResponse|error

Get Providers

Parameters

capability string? (default ()) - CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated

datasetFilter string? (default ()) - Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.

fullAccountNumberFields string? (default ()) - Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.

institutionId int? (default ()) - Institution Id for Single site selection

name string? (default ()) - Name in minimum 1 character or routing number.

priority string? (default ()) - Search priority

providerId string? (default ()) - Max 5 Comma seperated Provider Ids

skip int? (default ()) - skip (Min 0) - This is not applicable along with 'name' parameter.

top int? (default ()) - top (Max 500) - This is not applicable along with 'name' parameter.

Return Type

ProviderResponse|error - OK

getProvidersCount

Isolated FunctionRemote Function

function getProvidersCount(string? capability, string? datasetFilter, string? fullAccountNumberFields, string? name, string? priority) returns ProvidersCountResponse|error

Get Providers Count

Parameters

capability string? (default ()) - CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated

datasetFilter string? (default ()) - Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.

fullAccountNumberFields string? (default ()) - Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.

name string? (default ()) - Name in minimum 1 character or routing number.

priority string? (default ()) - Search priority

Return Type

ProvidersCountResponse|error - OK

getProvider

Isolated FunctionRemote Function

function getProvider(int providerId) returns ProviderDetailResponse|error

Get Provider Details

Parameters

providerId int - providerId

Return Type

ProviderDetailResponse|error - OK

getStatements

Isolated FunctionRemote Function

function getStatements(string? accountId, string? container, string? fromDate, string? isLatest, string? status) returns StatementResponse|error

Get Statements

Parameters

accountId string? (default ()) - accountId

container string? (default ()) - creditCard/loan/insurance

fromDate string? (default ()) - from date for statement retrieval (YYYY-MM-DD)

isLatest string? (default ()) - isLatest (true/false)

status string? (default ()) - ACTIVE,TO_BE_CLOSED,CLOSED

Return Type

StatementResponse|error - OK

getTransactions

Isolated FunctionRemote Function

function getTransactions(string? accountId, string? baseType, string? categoryId, string? categoryType, string? container, string? detailCategoryId, string? fromDate, string? highLevelCategoryId, string? keyword, int? skip, string? toDate, int? top, string? 'type) returns TransactionResponse|error

Get Transactions

Parameters

accountId string? (default ()) - Comma separated accountIds

baseType string? (default ()) - DEBIT/CREDIT

categoryId string? (default ()) - Comma separated categoryIds

categoryType string? (default ()) - Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)

container string? (default ()) - bank/creditCard/investment/insurance/loan

detailCategoryId string? (default ()) - Comma separated detailCategoryIds

fromDate string? (default ()) - Transaction from date(YYYY-MM-DD)

highLevelCategoryId string? (default ()) - Comma separated highLevelCategoryIds

keyword string? (default ()) - Transaction search text

skip int? (default ()) - skip (Min 0)

toDate string? (default ()) - Transaction end date (YYYY-MM-DD)

top int? (default ()) - top (Max 500)

'type string? (default ()) - Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment

Return Type

TransactionResponse|error - OK

getTransactionCategories

Isolated FunctionRemote Function

function getTransactionCategories() returns TransactionCategoryResponse|error

Get Transaction Category List

Return Type

TransactionCategoryResponse|error - OK

updateTransactionCategory

Isolated FunctionRemote Function

function updateTransactionCategory(UpdateCategoryRequest payload) returns Response|error

Update Category

Parameters

payload UpdateCategoryRequest - updateCategoryRequest

Return Type

Response|error - Updated Successfully

createTransactionCategory

Isolated FunctionRemote Function

function createTransactionCategory(TransactionCategoryRequest payload) returns Response|error

Create Category

Parameters

payload TransactionCategoryRequest - User Transaction Category in JSON format

Return Type

Response|error - Created Successfully

getTransactionCategorizationRulesDeprecated

DeprecatedIsolated FunctionRemote Function

function getTransactionCategorizationRulesDeprecated() returns TransactionCategorizationRule[]|error

Get Transaction Categorization Rules

Return Type

TransactionCategorizationRule[]|error - OK
Deprecated

createOrRunTransactionCategorizationRules

Isolated FunctionRemote Function

function createOrRunTransactionCategorizationRules(string? action, string? ruleParam) returns Response|error

Create or Run Transaction Categorization Rule

Parameters

action string? (default ()) - To run rules, pass action=run. Only value run is supported

ruleParam string? (default ()) - rules(JSON format) to categorize the transactions

Return Type

Response|error - Created Successfully

updateTransactionCategorizationRule

Isolated FunctionRemote Function

function updateTransactionCategorizationRule(int ruleId, TransactionCategorizationRuleRequest payload) returns Response|error

Update Transaction Categorization Rule

Parameters

ruleId int - ruleId

payload TransactionCategorizationRuleRequest - transactionCategoriesRuleRequest

Return Type

Response|error - Updated Successfully

runTransactionCategorizationRule

Isolated FunctionRemote Function

function runTransactionCategorizationRule(string action, int ruleId) returns Response|error

Run Transaction Categorization Rule

Parameters

action string - The action type

ruleId int - Unique id of the categorization rule

Return Type

Response|error - Run Successfully

deleteTransactionCategorizationRule

Isolated FunctionRemote Function

function deleteTransactionCategorizationRule(int ruleId) returns Response|error

Delete Transaction Categorization Rule

Parameters

ruleId int - ruleId

Return Type

Response|error - Deleted Successfully

getTransactionCategorizationRules

Isolated FunctionRemote Function

function getTransactionCategorizationRules() returns TransactionCategorizationRuleResponse|error

Get Transaction Categorization Rules

Return Type

TransactionCategorizationRuleResponse|error - OK

deleteTransactionCategory

Isolated FunctionRemote Function

function deleteTransactionCategory(int categoryId) returns Response|error

Delete Category

Parameters

categoryId int - categoryId

Return Type

Response|error - Deleted Successfully

getTransactionsCount

Isolated FunctionRemote Function

function getTransactionsCount(string? accountId, string? baseType, string? categoryId, string? categoryType, string? container, string? detailCategoryId, string? fromDate, string? highLevelCategoryId, string? keyword, string? toDate, string? 'type) returns TransactionCountResponse|error

Get Transactions Count

Parameters

accountId string? (default ()) - Comma separated accountIds

baseType string? (default ()) - DEBIT/CREDIT

categoryId string? (default ()) - Comma separated categoryIds

categoryType string? (default ()) - Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)

container string? (default ()) - bank/creditCard/investment/insurance/loan

detailCategoryId string? (default ()) - Comma separated detailCategoryIds

fromDate string? (default ()) - Transaction from date(YYYY-MM-DD)

highLevelCategoryId string? (default ()) - Comma separated highLevelCategoryIds

keyword string? (default ()) - Transaction search text

toDate string? (default ()) - Transaction end date (YYYY-MM-DD)

'type string? (default ()) - Transaction Type(SELL,SWEEP, etc.)

Return Type

TransactionCountResponse|error - OK

updateTransaction

Isolated FunctionRemote Function

function updateTransaction(int transactionId, TransactionRequest payload) returns Response|error

Update Transaction

Parameters

transactionId int - transactionId

payload TransactionRequest - transactionRequest

Return Type

Response|error - Updated Successfully

getUser

Isolated FunctionRemote Function

function getUser() returns UserDetailResponse|error

Get User Details

Return Type

UserDetailResponse|error - OK

updateUser

Isolated FunctionRemote Function

function updateUser(UpdateUserRequest payload) returns Response|error

Update User Details

Parameters

payload UpdateUserRequest - userRequest

Return Type

Response|error - No Content

getAccessTokens

Isolated FunctionRemote Function

function getAccessTokens(string appIds) returns UserAccessTokensResponse|error

Get Access Tokens

Parameters

appIds string - appIds

Return Type

UserAccessTokensResponse|error - OK

userLogout

Isolated FunctionRemote Function

function userLogout() returns Response|error

User Logout

Return Type

Response|error - Logout successful

registerUser

Isolated FunctionRemote Function

function registerUser(UserRequest payload) returns UserResponse|error

Parameters

payload UserRequest - userRequest

Return Type

UserResponse|error - Login Successful

samlLogin

Isolated FunctionRemote Function

function samlLogin(string issuer, string samlResponse, string? 'source) returns UserResponse|error

Saml Login

Parameters

issuer string - issuer

samlResponse string - samlResponse

'source string? (default ()) - source

Return Type

UserResponse|error - OK

unregister

Isolated FunctionRemote Function

function unregister() returns Response|error

Delete User

Return Type

Response|error - No Content

getVerificationStatus

Isolated FunctionRemote Function

function getVerificationStatus(string? accountId, string? providerAccountId, string? verificationType) returns VerificationStatusResponse|error

Get Verification Status

Parameters

accountId string? (default ()) - Comma separated accountId

providerAccountId string? (default ()) - Comma separated providerAccountId

verificationType string? (default ()) - verificationType

Return Type

VerificationStatusResponse|error - OK

verifyChallengeDeposit

Isolated FunctionRemote Function

function verifyChallengeDeposit(UpdateVerificationRequest payload) returns VerificationResponse|error

Verify Challenge Deposit

Parameters

payload UpdateVerificationRequest - verification information

Return Type

VerificationResponse|error - OK

initiateMatchingOrChallengeDepositeVerification

Isolated FunctionRemote Function

function initiateMatchingOrChallengeDepositeVerification(VerificationRequest payload) returns VerificationResponse|error

Initiaite Matching Service and Challenge Deposit

Parameters

payload VerificationRequest - verification information

Return Type

VerificationResponse|error - OK

initiateAccountVerification

Isolated FunctionRemote Function

function initiateAccountVerification(string providerAccountId, VerifyAccountRequest payload) returns VerifyAccountResponse|error

Verify Accounts Using Transactions

Parameters

providerAccountId string - providerAccountId

payload VerifyAccountRequest - verificationParam

Return Type

VerifyAccountResponse|error - OK

Records

yodlee: AccessTokens

Fields

appId string? - The identifier of the application for which the access token is generated. Endpoints:<ul><li>GET user/accessTokens</li></ul>

url string? - Base URL using which the application is accessed. Endpoints:<ul><li>GET user/accessTokens</li></ul>

value string? - Access token value used to invoke the widgets/apps. Endpoints:<ul><li>GET user/accessTokens</li></ul>

yodlee: Account

Fields

'401kLoan Money? -

CONTAINER string? - The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc. Aggregated / Manual: Aggregated Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

accountName string? - The account name as it appears at the site. (The POST accounts service response return this field as name) Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

accountNumber string? - The account number as it appears on the site. (The POST accounts service response return this field as number) Additional Details: Bank/ Loan/ Insurance/ Investment: The account number for the bank account as it appears at the site. Credit Card: The account number of the card account as it appears at the site, i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it. Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>

accountStatus string? - The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus Additional Details: ACTIVE: All the added manual and aggregated accounts status will be made "ACTIVE" by default. TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services CLOSED: Users can update the status as CLOSED, if the account is closed with the provider. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

accountType string? - The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account. Valid Values: Aggregated Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PPF</li><li>RECURRING_DEPOSIT</li><li>FSA</li><li>MONEY_MARKET</li><li>IRA</li><li>PREPAID</li></ul>creditCard<ul><li>OTHER</li><li>CREDIT</li><li>STORE</li><li>CHARGE</li><li>OTHER</li></ul>investment (SN 1.0)<ul><li>BROKERAGE_MARGIN</li><li>HSA</li><li>IRA</li><li>BROKERAGE_CASH</li><li>401K</li><li>403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE</li><li>CUSTODIAL</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE</li><li>JTTIC</li><li>JTWROS</li><li>COMMUNITY_PROPERTY</li><li>JOINT_BY_ENTIRETY</li><li>CONSERVATORSHIP</li><li>ROTH</li><li>ROTH_CONVERSION</li><li>ROLLOVER</li><li>EDUCATIONAL</li><li>529_PLAN</li><li>457_DEFERRED_COMPENSATION</li><li>401A</li><li>PSP</li><li>MPP</li><li>STOCK_BASKET</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER</li><li>CHARITABLE_LEAD</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP</li><li>UTMA</li><li>UGMA</li><li>ESOPP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>SOLE_PROPRIETORSHIP</li><li>CHURCH</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CMA</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET</li><li>SUPER_ANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN</li><li>DEFERRED_PROFIT_SHARING_PLAN</li><li>NON_REGISTERED_SAVINGS_PLAN</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN</li><li>GROUP_RETIREMENT_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_ACCOUNT</li><li>REGISTERED_PENSION_PLAN</li><li>TAX_FREE_SAVINGS_ACCOUNT</li><li>LIFE_INCOME_FUND</li><li>REGISTERED_RETIREMENT_INCOME_FUND</li><li>SPOUSAL_RETIREMENT_INCOME_FUND</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND</li><li>GUARANTEED_INVESTMENT_CERTIFICATES</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN</li><li>OTHER</li></ul>investment (SN 2.0)<ul><li>BROKERAGE_CASH</li><li>BROKERAGE_MARGIN</li><li>INDIVIDUAL_RETIREMENT_ACCOUNT_IRA</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_401K</li><li>EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE_IRA</li><li>CUSTODIAL_ACCOUNT</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE_INVESTMENT_ACCOUNT</li><li>JOINT_TENANTS_TENANCY_IN_COMMON_JTIC</li><li>JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS</li><li>JOINT_TENANTS_COMMUNITY_PROPERTY</li><li>JOINT_TENANTS_TENANTS_BY_ENTIRETY</li><li>CONSERVATOR</li><li>ROTH_IRA</li><li>ROTH_CONVERSION</li><li>ROLLOVER_IRA</li><li>EDUCATIONAL</li><li>EDUCATIONAL_SAVINGS_PLAN_529</li><li>DEFERRED_COMPENSATION_PLAN_457</li><li>MONEY_PURCHASE_RETIREMENT_PLAN_401A</li><li>PROFIT_SHARING_PLAN</li><li>MONEY_PURCHASE_PLAN</li><li>STOCK_BASKET_ACCOUNT</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER_TRUST</li><li>CHARITABLE_LEAD_TRUST</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP_IRA</li><li>UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA</li><li>UNIFORM_GIFT_TO_MINORS_ACT_UGMA</li><li>EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>PROPRIETORSHIP</li><li>CHURCH_ACCOUNT</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CASH_MANAGEMENT_ACCOUNT</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET_ACCOUNT</li><li>SUPERANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP</li><li>DEFERRED_PROFIT_SHARING_PLAN_DPSP</li><li>NON_REGISTERED_SAVINGS_PLAN_NRSP</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN_RESP</li><li>GROUP_RETIREMENT_SAVINGS_PLAN_GRSP</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP</li><li>LOCKED_IN_RETIREMENT_ACCOUNT_LIRA</li><li>REGISTERED_PENSION_PLAN_RPP</li><li>TAX_FREE_SAVINGS_ACCOUNT_TFSA</li><li>LIFE_INCOME_FUND_LIF</li><li>REGISTERED_RETIREMENT_INCOME_FUND_RIF</li><li>SPOUSAL_RETIREMENT_INCOME_FUND_SRIF</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF</li><li>GUARANTEED_INVESTMENT_CERTIFICATES_GIC</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP</li><li>DEFINED_CONTRIBUTION_PLAN</li><li>DEFINED_BENEFIT_PLAN</li><li>EMPLOYEE_STOCK_OPTION_PLAN</li><li>NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A</li><li>KEOGH_PLAN</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K</li><li>DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP</li><li>EMPLOYEE_BENEFIT_PLAN</li><li>EMPLOYEE_SAVINGS_PLAN</li><li>HEALTH_SAVINGS_ACCOUNT_HSA</li><li>COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA</li><li>TESTAMENTARY_TRUST</li><li>ESTATE</li><li>GRANTOR_RETAINED_ANNUITY_TRUST_GRAT</li><li>ADVISORY_ACCOUNT</li><li>NON_PROFIT_ORGANIZATION_501C</li><li>HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA</li><li>INDIVIDUAL_SAVINGS_ACCOUNT_ISA</li><li>CASH_ISA</li><li>STOCKS_AND_SHARES_ISA</li><li>INNOVATIVE_FINANCE_ISA</li><li>JUNIOR_ISA</li><li>EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO</li><li>PUBLIC_PROVIDENT_FUND_PPF</li><li>EMPLOYEES_PENSION_SCHEME_EPS</li><li>NATIONAL_PENSION_SYSTEM_NPS</li><li>INDEXED_ANNUITY</li><li>ANNUITIZED_ANNUITY</li><li>VARIABLE_ANNUITY</li><li>ROTH_403B</li><li>SPOUSAL_IRA</li><li>SPOUSAL_ROTH_IRA</li><li>SARSEP_IRA</li><li>SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP</li><li>OFFSHORE_TRUST</li><li>IRREVOCABLE_LIFE_INSURANCE_TRUST</li><li>INTERNATIONAL_TRUST</li><li>LIFE_INTEREST_TRUST</li><li>EMPLOYEE_BENEFIT_TRUST</li><li>PRECIOUS_METAL_ACCOUNT</li><li>INVESTMENT_LOAN_ACCOUNT</li><li>GRANTOR_RETAINED_INCOME_TRUST</li><li>PENSION_PLAN</li><li>OTHER</li></ul>loan<ul><li>MORTGAGE</li><li>INSTALLMENT_LOAN</li><li>PERSONAL_LOAN</li><li>HOME_EQUITY_LINE_OF_CREDIT</li><li>LINE_OF_CREDIT</li><li>AUTO_LOAN</li><li>STUDENT_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>AUTO_INSURANCE</li><li>HEALTH_INSURANCE</li><li>HOME_INSURANCE</li><li>LIFE_INSURANCE</li><li>ANNUITY</li><li>TRAVEL_INSURANCE</li><li>INSURANCE</li></ul>realEstate<ul> <li>REAL_ESTATE</li></ul>reward<ul><li>REWARD_POINTS</li></ul>Manual Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PREPAID</li></ul>credit<ul> <li>CREDIT</li></ul>loan<ul> <li>PERSONAL_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>INSURANCE</li><li>ANNUITY</li></ul>investment<ul><li>BROKERAGE_CASH</li></ul> Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

address AccountAddress? -

aggregationSource string? - The source through which the account(s) are added in the system. Valid Values: SYSTEM, USER Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

amountDue Money? -

annualPercentageYield decimal? - Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account. Applicable containers: bank Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

annuityBalance Money? -

apr decimal? - The annual percentage rate (APR) is the yearly rate of interest on the credit card account. Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance. Aggregated / Manual: Aggregated Applicable containers: creditCard Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

associatedProviderAccountId int[]? - The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time. Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts. Aggregated / Manual: Aggregated Applicable containers: All Containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

autoRefresh AutoRefresh? -

availableBalance Money? -

availableCash Money? -

availableCredit Money? -

balance Money? -

bankTransferCode BankTransferCode[]? - Bank and branch identification information. Aggregated / Manual: Aggregated Applicable containers: bank, investment, loan Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

cash Money? -

cashApr decimal? - Annual percentage rate applied to cash withdrawals on the card. Account Type: Aggregated Applicable containers: creditCard Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

cashValue Money? -

classification string? - The classification of the account such as personal, corporate, etc. Aggregated / Manual: Aggregated Applicable containers: bank, creditCard, investment, reward, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

collateral string? - Property or possession offered to support a loan that can be seized on a default. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

coverage Coverage[]? - The coverage-related details of the account. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

createdDate string? - The date on which the account is created in the Yodlee system. Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

currentBalance Money? -

currentLevel string? - Current level of the reward program the user is associated with. E.g. Silver, Jade etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Aggregated / Manual: Aggregated Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

deathBenefit Money? -

derivedApr decimal? - Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase. Aggregated / Manual / Derived: Derived Applicable containers: creditCard Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

displayedName string? - The name or identification of the account owner, as it appears at the FI site. Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page. Aggregated / Manual: Aggregated Applicable containers: bank, creditCard, investment, insurance, loan, reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

dueDate string? - The date on which the due amount has to be paid. Additional Details: Credit Card: The monthly date by when the minimum payment is due to be paid on the credit card account. Loan: The date on or before which the due amount should be paid. Note: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: creditCard, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

enrollmentDate string? - Date on which the user is enrolled on the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

escrowBalance Money? -

estimatedDate string? - The date on which the home value was estimated. Aggregated / Manual: Manual Applicable containers: realEstate Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

expirationDate string? - The date on which the insurance policy expires or matures. Additional Details: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

faceAmount Money? -

frequency string? - The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account. Aggregated / Manual: Both Applicable containers: creditCard, insurance, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

fullAccountNumber string? - Full account number of the account that is included only when include = fullAccountNumber is provided in the request. For student loan account the account number that will be used for ACH or fund transfer Aggregated / Manual: Both Applicable containers: bank, creditCard, investment, insurance, loan, reward, otherAssets, otherLiabilities Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li> Note : fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</ul>

fullAccountNumberList FullAccountNumberList? -

guarantor string? - A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

holder AccountHolder[]? - Holder details of the account. Aggregated / Manual: Aggregated Applicable containers: bank Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

homeInsuranceType string? - Type of home insurance, like -<ul><li>HOME_OWNER</li><li>RENTAL</li><li>RENTER</li><li>etc..</li></ul>Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

homeValue Money? -

id int? - The primary key of the account resource and the unique identifier for the account. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>GET investmentOptions</li><li>GET accounts/historicalBalances</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>

includeInNetWorth boolean? - Used to determine whether an account to be considered in the networth calculation. Aggregated / Manual: Aggregated Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

interestPaidLastYear Money? -

interestPaidYTD Money? -

interestRate decimal? - Bank: The interest rate offered by a FI to its depositors on a bank account. Loan: Interest rate applied on the loan. Additional Details: Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

interestRateType string? - The type of the interest rate, for example, fixed or variable. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

isAsset boolean? - The account to be considered as an asset or liability. Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastEmployeeContributionAmount Money? -

lastEmployeeContributionDate string? - The date on which the last employee contribution was made to the 401k account. Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type. Aggregated / Manual: Aggregated Applicable containers: investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastPayment Money? -

lastPaymentAmount Money? -

lastPaymentDate string? - The date on which the payment for the previous or current billing cycle is done. Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: creditCard, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - The date time the account information was last retrieved from the provider site and updated in the Yodlee system. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lender string? - The financial institution that provides the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lifeInsuranceType string? - Type of life insurance. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

loanPayByDate string? - The date by which the payoff amount should be paid. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

loanPayoffAmount Money? -

loanPayoffDetails LoanPayoffDetails? -

marginBalance Money? -

maturityAmount Money? -

maturityDate string? - The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid. Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

memo string? - The additional description or notes given by the user. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

minimumAmountDue Money? -

moneyMarketBalance Money? -

nextLevel string? - The eligible next level of the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

nickname string? - The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

originalLoanAmount Money? -

originationDate string? - The date on which the loan is disbursed. Aggregated / Manual: Both Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

overDraftLimit Money? -

paymentProfile PaymentProfile? -

policyEffectiveDate string? - The date on which the insurance policy coverage commences. Applicable containers: insurance Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyFromDate string? - The date the insurance policy began. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyStatus string? - The status of the policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

policyTerm string? - The duration for which the policy is valid or in effect. For example, one year, five years, etc. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyToDate string? - The date to which the policy exists. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

premium Money? -

premiumPaymentTerm string? - The number of years for which premium payments have to be made in a policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

primaryRewardUnit string? - Primary reward unit for this reward program. E.g. miles, points, etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

principalBalance Money? -

profile AccountProfile? -

providerAccountId int? - The primary key of the provider account resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

providerId string? - Identifier of the provider site. The primary key of provider resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

providerName string? - Service provider or institution name where the account originates. This belongs to the provider resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

recurringPayment Money? -

remainingBalance Money? -

repaymentPlanType string? - The type of repayment plan that the borrower prefers to repay the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values:

rewardBalance RewardBalance[]? - Information of different reward balances associated with the account. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

runningBalance Money? -

shortBalance Money? -

sourceAccountStatus string? - Indicates the status of the loan account. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values:

sourceId string? - A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts. Applicable containers: bank, creditCard, investment, insurance, loan, reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

term string? - The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid. Additional Details: Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

totalCashLimit Money? -

totalCreditLimit Money? -

totalCreditLine Money? -

totalUnvestedBalance Money? -

totalVestedBalance Money? -

userClassification string? - Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities Endpoints:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>POST accounts</ul><li>GET dataExtracts/userData</li>Applicable Values

valuationType string? - The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners. Aggregated / Manual: Manual Applicable containers: realEstate Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: AccountAddress

Fields

address1 string? -

address2 string? -

address3 string? -

city string? -

country string? -

sourceType string? -

state string? -

street string? -

'type string? -

zip string? -

yodlee: AccountDataset

Fields

additionalStatus string? - The status of last update attempted for the dataset. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>Applicable Values

lastUpdateAttempt string? - Indicate when the last attempt was performed to update the dataset for the given provider account Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

lastUpdated string? - Indicate when the dataset is last updated successfully for the given provider account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

name string? - The name of the dataset requested from the provider site Account Type: Manual Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

nextUpdateScheduled string? - Indicates when the next attempt to update the dataset is scheduled. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

updateEligibility string? - Indicate whether the dataset is eligible for update or not. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>Applicable Values

yodlee: AccountHistoricalBalancesResponse

Fields

account AccountHistory[]? -

yodlee: AccountHistory

Fields

historicalBalances HistoricalBalance[]? -

id int? -

yodlee: AccountHolder

Fields

gender string? - Identifiers of the account holder. Aggregated / Manual: Aggregated Applicable containers: bank Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

identifier Identifier[]? - Identifiers of the account holder. Aggregated / Manual: Aggregated Applicable containers: bank Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

name Name? -

ownership string? - Indicates the ownership of the account. Aggregated / Manual: Aggregated Applicable containers: bank Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values

yodlee: AccountProfile

Fields

address AccountAddress[]? - Address available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

email Email[]? - Email Id available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

identifier Identifier[]? - Identifiers available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

phoneNumber PhoneNumber[]? - Phone number available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

yodlee: AccountResponse

Fields

account Account[]? -

yodlee: ApiKeyOutput

Fields

createdDate string? - The date on which the apiKey was created for the customer. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

expiresIn int? - Time in seconds after which the JWT token created for users expires. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

'key string? - ApiKey or the issuer key used to generate the JWT token for authentication. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

publicKey string? - Public key uploaded by the customer while generating ApiKey. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

yodlee: ApiKeyRequest

Fields

publicKey string? - Public key uploaded by the customer while generating ApiKey. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

yodlee: ApiKeyResponse

Fields

apiKey ApiKeyOutput[]? - ApiKey customer details. Endpoints:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>

yodlee: AssetClassification

Fields

allocation decimal? - The allocation percentage of the holding. Required Feature Enablement: Asset classification feature Applicable containers: investment

classificationType string? - The type of classification to which the investment belongs (assetClass, country, sector, and style). Required Feature Enablement: Asset classification feature Applicable containers: investment

classificationValue string? - The value for each classificationType. Required Feature Enablement: Asset classification feature Applicable containers: investment

yodlee: AssetClassificationList

Fields

classificationType string? - The type of classification to which the investment belongs (assetClass, country, sector, and style). Required Feature Enablement: Asset classification feature Applicable containers: investment

classificationValue string[]? - The value for each classificationType. Required Feature Enablement: Asset classification feature Applicable containers: investment

yodlee: Attribute

Fields

container string[]? - Containers for which the attributes are supported. Endpoints:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>

containerAttributes ContainerAttributes? -

fromDate string? - Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset. Endpoints:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>

fromFinYear string? - Applicable only to TAX attribute of DOCUMENT dataset. Endpoints:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>

name string? - Attributes that are supported for a dataset. Endpoints:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>

toDate string? - Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset. Endpoints:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>

toFinYear string? - Applicable only to TAX attribute of DOCUMENT dataset. Endpoints:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>

yodlee: AutoRefresh

Fields

additionalStatus string? - Indicates the reason for the status. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values

asOfDate string? - Date on which the auto refresh status is determined. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

status string? - Indicates whether auto refresh is enabled or disabled. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values

yodlee: BankTransferCode

Fields

id string? - The FI's branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). Account Type: Aggregated Applicable containers: bank, investment Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>

'type string? - The bank transfer code type varies depending on the region of the account origination. Account Type: Aggregated Applicable containers: bank, investment Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>Applicable Values

yodlee: Capability

Fields

container string[]? -

name string? -

yodlee: ClientCredentialToken

Fields

accessToken string? - Access Token to access YSL 1.1 services. Endpoints:<ul><li>POST /auth/token</li></ul>

expiresIn int? - Time in seconds after which the issued accessToken expires. Endpoints:<ul><li>POST /auth/token</li></ul>

issuedAt string? - The date and time on which accessToken was created for the customer. Endpoints:<ul><li>POST /auth/token</li></ul>

yodlee: ClientCredentialTokenResponse

Fields

token ClientCredentialToken? -

yodlee: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

yodlee: Cobrand

Fields

cobrandLogin string -

cobrandPassword string -

locale string? - The customer's locale that will be considered for the localization functionality. Endpoints:<ul><li>POST cobrand/login</li></ul>

yodlee: CobrandLoginRequest

Fields

cobrand Cobrand -

yodlee: CobrandLoginResponse

Fields

applicationId string? - The application identifier. Endpoints:<ul><li>POST cobrand/login</li></ul>

cobrandId int? - Unique identifier of the cobrand (customer) in the system. Endpoints:<ul><li>POST cobrand/login</li></ul>

locale string? - The customer's locale that will be considered for the localization functionality. Endpoints:<ul><li>POST cobrand/login</li></ul>

session CobrandSession? -

yodlee: CobrandNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET cobrand/config/notifications/events</li></ul>

name string? - Name of the event for which the customers must subscribe to receive notifications. Valid Value: Notification Events Name Endpoints:<ul><li>GET cobrand/config/notifications/events</li></ul>Applicable Values

yodlee: CobrandNotificationResponse

Fields

event CobrandNotificationEvent[]? -

yodlee: CobrandPublicKeyResponse

Fields

keyAlias string? - The key name used for encryption. Endpoints:<ul><li>GET cobrand/publicKey</li></ul>

keyAsPemString string? - Public key that the customer should be using to encrypt the credentials and answers before sending to the add & update providerAccounts APIs. Endpoints:<ul><li>GET cobrand/publicKey</li></ul>

yodlee: CobrandSession

Fields

cobSession string? -

yodlee: ConfigsNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET configs/notifications/events</li></ul>

name string? - Name of the event for which the customers must subscribe to receive notifications. Valid Value: Notification Events Name Endpoints:<ul><li>GET configs/notifications/events</li></ul>Applicable Values

yodlee: ConfigsNotificationResponse

Fields

event ConfigsNotificationEvent[]? -

yodlee: ConfigsPublicKey

Fields

alias string? - The key name used for encryption. Endpoints:<ul><li>GET configs/publicKey</li></ul>

'key string? - Public key that the customer should be using to encrypt the credentials and answers before sending to the add and update providerAccounts APIs. Endpoints:<ul><li>GET configs/publicKey</li></ul>

yodlee: ConfigsPublicKeyResponse

Fields

publicKey ConfigsPublicKey? -

yodlee: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth BearerTokenConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig PoolConfiguration? - Configurations associated with request pooling

cache CacheConfig? - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig? - Configurations associated with retrying

responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits

secureSocket ClientSecureSocket? - SSL/TLS-related options

proxy ProxyConfig? - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

yodlee: Contact

Fields

email string? - Email Id of the merchant Applicable containers: bank,creditCard,investment,loan

phone string? - Phone number of the merchant Applicable containers: bank,creditCard,investment,loan

yodlee: ContainerAttributes

Fields

BANK TransactionDays? -

CREDITCARD TransactionDays? -

INSURANCE TransactionDays? -

INVESTMENT TransactionDays? -

LOAN TransactionDays? -

yodlee: Coordinates

Fields

latitude decimal? - Latitude of the merchant Applicable containers: bank,creditCard,loan

longitude decimal? - Longitude of the merchant Applicable containers: bank,creditCard,loan

yodlee: Coverage

Fields

amount CoverageAmount[]? - The coverage amount-related details. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

endDate string? - The date on which the coverage for the account ends or expires. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

planType string? - The plan type for an insurance provided to an individual or an entity. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values:

startDate string? - The date on which the coverage for the account starts. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

'type string? - The type of coverage provided to an individual or an entity. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values:

yodlee: CoverageAmount

Fields

cover Money? -

limitType string? - The type of coverage limit indicates if the coverage is in-network or out-of-network. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values:

met Money? -

'type string? - The type of coverage provided to an individual or an entity. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values:

unitType string? - The type of coverage unit indicates if the coverage is for an individual or a family. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>Applicable Values:

yodlee: CreateAccountInfo

Fields

accountName string -

accountNumber string? -

accountType string -

address AccountAddress? -

amountDue Money? -

balance Money? -

dueDate string? -

frequency string? -

homeValue Money? -

includeInNetWorth string? -

memo string? -

nickname string? -

valuationType string? -

yodlee: CreateAccountRequest

Fields

account CreateAccountInfo -

yodlee: CreateCobrandNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET cobrand/config/notifications/events</li></ul>

yodlee: CreateCobrandNotificationEventRequest

Fields

event CreateCobrandNotificationEvent -

yodlee: CreateConfigsNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET configs/notifications/events</li></ul>

yodlee: CreateConfigsNotificationEventRequest

Fields

event CreateConfigsNotificationEvent -

yodlee: CreatedAccountInfo

Fields

accountName string? -

accountNumber string? -

id int? -

yodlee: CreatedAccountResponse

Fields

account CreatedAccountInfo[]? -

yodlee: DataExtractsAccount

Fields

'401kLoan Money? -

CONTAINER string? - The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc. Aggregated / Manual: Aggregated Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

accountName string? - The account name as it appears at the site. (The POST accounts service response return this field as name) Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

accountNumber string? - The account number as it appears on the site. (The POST accounts service response return this field as number) Additional Details: Bank/ Loan/ Insurance/ Investment: The account number for the bank account as it appears at the site. Credit Card: The account number of the card account as it appears at the site, i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it. Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>

accountStatus string? - The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus Additional Details: ACTIVE: All the added manual and aggregated accounts status will be made "ACTIVE" by default. TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services CLOSED: Users can update the status as CLOSED, if the account is closed with the provider. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

accountType string? - The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account. Valid Values: Aggregated Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PPF</li><li>RECURRING_DEPOSIT</li><li>FSA</li><li>MONEY_MARKET</li><li>IRA</li><li>PREPAID</li></ul>creditCard<ul><li>OTHER</li><li>CREDIT</li><li>STORE</li><li>CHARGE</li><li>OTHER</li></ul>investment (SN 1.0)<ul><li>BROKERAGE_MARGIN</li><li>HSA</li><li>IRA</li><li>BROKERAGE_CASH</li><li>401K</li><li>403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE</li><li>CUSTODIAL</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE</li><li>JTTIC</li><li>JTWROS</li><li>COMMUNITY_PROPERTY</li><li>JOINT_BY_ENTIRETY</li><li>CONSERVATORSHIP</li><li>ROTH</li><li>ROTH_CONVERSION</li><li>ROLLOVER</li><li>EDUCATIONAL</li><li>529_PLAN</li><li>457_DEFERRED_COMPENSATION</li><li>401A</li><li>PSP</li><li>MPP</li><li>STOCK_BASKET</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER</li><li>CHARITABLE_LEAD</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP</li><li>UTMA</li><li>UGMA</li><li>ESOPP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>SOLE_PROPRIETORSHIP</li><li>CHURCH</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CMA</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET</li><li>SUPER_ANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN</li><li>DEFERRED_PROFIT_SHARING_PLAN</li><li>NON_REGISTERED_SAVINGS_PLAN</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN</li><li>GROUP_RETIREMENT_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_ACCOUNT</li><li>REGISTERED_PENSION_PLAN</li><li>TAX_FREE_SAVINGS_ACCOUNT</li><li>LIFE_INCOME_FUND</li><li>REGISTERED_RETIREMENT_INCOME_FUND</li><li>SPOUSAL_RETIREMENT_INCOME_FUND</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND</li><li>GUARANTEED_INVESTMENT_CERTIFICATES</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN</li><li>OTHER</li></ul>investment (SN 2.0)<ul><li>BROKERAGE_CASH</li><li>BROKERAGE_MARGIN</li><li>INDIVIDUAL_RETIREMENT_ACCOUNT_IRA</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_401K</li><li>EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE_IRA</li><li>CUSTODIAL_ACCOUNT</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE_INVESTMENT_ACCOUNT</li><li>JOINT_TENANTS_TENANCY_IN_COMMON_JTIC</li><li>JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS</li><li>JOINT_TENANTS_COMMUNITY_PROPERTY</li><li>JOINT_TENANTS_TENANTS_BY_ENTIRETY</li><li>CONSERVATOR</li><li>ROTH_IRA</li><li>ROTH_CONVERSION</li><li>ROLLOVER_IRA</li><li>EDUCATIONAL</li><li>EDUCATIONAL_SAVINGS_PLAN_529</li><li>DEFERRED_COMPENSATION_PLAN_457</li><li>MONEY_PURCHASE_RETIREMENT_PLAN_401A</li><li>PROFIT_SHARING_PLAN</li><li>MONEY_PURCHASE_PLAN</li><li>STOCK_BASKET_ACCOUNT</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER_TRUST</li><li>CHARITABLE_LEAD_TRUST</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP_IRA</li><li>UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA</li><li>UNIFORM_GIFT_TO_MINORS_ACT_UGMA</li><li>EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>PROPRIETORSHIP</li><li>CHURCH_ACCOUNT</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CASH_MANAGEMENT_ACCOUNT</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET_ACCOUNT</li><li>SUPERANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP</li><li>DEFERRED_PROFIT_SHARING_PLAN_DPSP</li><li>NON_REGISTERED_SAVINGS_PLAN_NRSP</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN_RESP</li><li>GROUP_RETIREMENT_SAVINGS_PLAN_GRSP</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP</li><li>LOCKED_IN_RETIREMENT_ACCOUNT_LIRA</li><li>REGISTERED_PENSION_PLAN_RPP</li><li>TAX_FREE_SAVINGS_ACCOUNT_TFSA</li><li>LIFE_INCOME_FUND_LIF</li><li>REGISTERED_RETIREMENT_INCOME_FUND_RIF</li><li>SPOUSAL_RETIREMENT_INCOME_FUND_SRIF</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF</li><li>GUARANTEED_INVESTMENT_CERTIFICATES_GIC</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP</li><li>DEFINED_CONTRIBUTION_PLAN</li><li>DEFINED_BENEFIT_PLAN</li><li>EMPLOYEE_STOCK_OPTION_PLAN</li><li>NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A</li><li>KEOGH_PLAN</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K</li><li>DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP</li><li>EMPLOYEE_BENEFIT_PLAN</li><li>EMPLOYEE_SAVINGS_PLAN</li><li>HEALTH_SAVINGS_ACCOUNT_HSA</li><li>COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA</li><li>TESTAMENTARY_TRUST</li><li>ESTATE</li><li>GRANTOR_RETAINED_ANNUITY_TRUST_GRAT</li><li>ADVISORY_ACCOUNT</li><li>NON_PROFIT_ORGANIZATION_501C</li><li>HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA</li><li>INDIVIDUAL_SAVINGS_ACCOUNT_ISA</li><li>CASH_ISA</li><li>STOCKS_AND_SHARES_ISA</li><li>INNOVATIVE_FINANCE_ISA</li><li>JUNIOR_ISA</li><li>EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO</li><li>PUBLIC_PROVIDENT_FUND_PPF</li><li>EMPLOYEES_PENSION_SCHEME_EPS</li><li>NATIONAL_PENSION_SYSTEM_NPS</li><li>INDEXED_ANNUITY</li><li>ANNUITIZED_ANNUITY</li><li>VARIABLE_ANNUITY</li><li>ROTH_403B</li><li>SPOUSAL_IRA</li><li>SPOUSAL_ROTH_IRA</li><li>SARSEP_IRA</li><li>SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP</li><li>OFFSHORE_TRUST</li><li>IRREVOCABLE_LIFE_INSURANCE_TRUST</li><li>INTERNATIONAL_TRUST</li><li>LIFE_INTEREST_TRUST</li><li>EMPLOYEE_BENEFIT_TRUST</li><li>PRECIOUS_METAL_ACCOUNT</li><li>INVESTMENT_LOAN_ACCOUNT</li><li>GRANTOR_RETAINED_INCOME_TRUST</li><li>PENSION_PLAN</li><li>OTHER</li></ul>loan<ul><li>MORTGAGE</li><li>INSTALLMENT_LOAN</li><li>PERSONAL_LOAN</li><li>HOME_EQUITY_LINE_OF_CREDIT</li><li>LINE_OF_CREDIT</li><li>AUTO_LOAN</li><li>STUDENT_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>AUTO_INSURANCE</li><li>HEALTH_INSURANCE</li><li>HOME_INSURANCE</li><li>LIFE_INSURANCE</li><li>ANNUITY</li><li>TRAVEL_INSURANCE</li><li>INSURANCE</li></ul>realEstate<ul> <li>REAL_ESTATE</li></ul>reward<ul><li>REWARD_POINTS</li></ul>Manual Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PREPAID</li></ul>credit<ul> <li>CREDIT</li></ul>loan<ul> <li>PERSONAL_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>INSURANCE</li><li>ANNUITY</li></ul>investment<ul><li>BROKERAGE_CASH</li></ul> Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

address AccountAddress? -

aggregationSource string? - The source through which the account(s) are added in the system. Valid Values: SYSTEM, USER Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

amountDue Money? -

annualPercentageYield decimal? - Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account. Applicable containers: bank Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

annuityBalance Money? -

apr decimal? - The annual percentage rate (APR) is the yearly rate of interest on the credit card account. Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance. Aggregated / Manual: Aggregated Applicable containers: creditCard Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

associatedProviderAccountId int[]? - The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time. Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts. Aggregated / Manual: Aggregated Applicable containers: All Containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

availableBalance Money? -

availableCash Money? -

availableCredit Money? -

balance Money? -

bankTransferCode BankTransferCode[]? - Bank and branch identification information. Aggregated / Manual: Aggregated Applicable containers: bank, investment, loan Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

cash Money? -

cashApr decimal? - Annual percentage rate applied to cash withdrawals on the card. Account Type: Aggregated Applicable containers: creditCard Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

cashValue Money? -

classification string? - The classification of the account such as personal, corporate, etc. Aggregated / Manual: Aggregated Applicable containers: bank, creditCard, investment, reward, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

collateral string? - Property or possession offered to support a loan that can be seized on a default. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

coverage Coverage[]? - The coverage-related details of the account. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

createdDate string? - The date on which the account is created in the Yodlee system. Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

currentBalance Money? -

currentLevel string? - Current level of the reward program the user is associated with. E.g. Silver, Jade etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Aggregated / Manual: Aggregated Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

deathBenefit Money? -

derivedApr decimal? - Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase. Aggregated / Manual / Derived: Derived Applicable containers: creditCard Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

displayedName string? - The name or identification of the account owner, as it appears at the FI site. Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page. Aggregated / Manual: Aggregated Applicable containers: bank, creditCard, investment, insurance, loan, reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

dueDate string? - The date on which the due amount has to be paid. Additional Details: Credit Card: The monthly date by when the minimum payment is due to be paid on the credit card account. Loan: The date on or before which the due amount should be paid. Note: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: creditCard, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

enrollmentDate string? - Date on which the user is enrolled on the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

escrowBalance Money? -

estimatedDate string? - The date on which the home value was estimated. Aggregated / Manual: Manual Applicable containers: realEstate Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

expirationDate string? - The date on which the insurance policy expires or matures. Additional Details: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

faceAmount Money? -

frequency string? - The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account. Aggregated / Manual: Both Applicable containers: creditCard, insurance, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

guarantor string? - A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

homeInsuranceType string? - Type of home insurance, like -<ul><li>HOME_OWNER</li><li>RENTAL</li><li>RENTER</li><li>etc..</li></ul>Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

homeValue Money? -

id int? - The primary key of the account resource and the unique identifier for the account. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>GET investmentOptions</li><li>GET accounts/historicalBalances</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>

includeInNetWorth boolean? - Used to determine whether an account to be considered in the networth calculation. Aggregated / Manual: Aggregated Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

interestPaidLastYear Money? -

interestPaidYTD Money? -

interestRate decimal? - Bank: The interest rate offered by a FI to its depositors on a bank account. Loan: Interest rate applied on the loan. Additional Details: Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

interestRateType string? - The type of the interest rate, for example, fixed or variable. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

isAsset boolean? - The account to be considered as an asset or liability. Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

isDeleted boolean? - Indicates if the account is marked as deleted.Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastEmployeeContributionAmount Money? -

lastEmployeeContributionDate string? - The date on which the last employee contribution was made to the 401k account. Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type. Aggregated / Manual: Aggregated Applicable containers: investment Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastPayment Money? -

lastPaymentAmount Money? -

lastPaymentDate string? - The date on which the payment for the previous or current billing cycle is done. Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer. Aggregated / Manual: Aggregated Applicable containers: creditCard, loan, insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - The date time the account information was last retrieved from the provider site and updated in the Yodlee system. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lender string? - The financial institution that provides the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

lifeInsuranceType string? - Type of life insurance. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

loanPayByDate string? - The date by which the payoff amount should be paid. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

loanPayoffAmount Money? -

loanPayoffDetails LoanPayoffDetails? -

marginBalance Money? -

maturityAmount Money? -

maturityDate string? - The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid. Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

memo string? - The additional description or notes given by the user. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

minimumAmountDue Money? -

moneyMarketBalance Money? -

nextLevel string? - The eligible next level of the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

nickname string? - The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

originalLoanAmount Money? -

originationDate string? - The date on which the loan is disbursed. Aggregated / Manual: Both Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

overDraftLimit Money? -

policyEffectiveDate string? - The date on which the insurance policy coverage commences. Applicable containers: insurance Aggregated / Manual: Aggregated Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyFromDate string? - The date the insurance policy began. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyStatus string? - The status of the policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

policyTerm string? - The duration for which the policy is valid or in effect. For example, one year, five years, etc. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

policyToDate string? - The date to which the policy exists. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

premium Money? -

premiumPaymentTerm string? - The number of years for which premium payments have to be made in a policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

primaryRewardUnit string? - Primary reward unit for this reward program. E.g. miles, points, etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

principalBalance Money? -

providerAccountId int? - The primary key of the provider account resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

providerId string? - Identifier of the provider site. The primary key of provider resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

providerName string? - Service provider or institution name where the account originates. This belongs to the provider resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

recurringPayment Money? -

remainingBalance Money? -

repaymentPlanType string? - The type of repayment plan that the borrower prefers to repay the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values:

rewardBalance RewardBalance[]? - Information of different reward balances associated with the account. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

runningBalance Money? -

shortBalance Money? -

sourceAccountStatus string? - Indicates the status of the loan account. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values:

sourceId string? - A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts. Applicable containers: bank, creditCard, investment, insurance, loan, reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

term string? - The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid. Additional Details: Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term. Aggregated / Manual: Aggregated Applicable containers: bank, loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

totalCashLimit Money? -

totalCreditLimit Money? -

totalCreditLine Money? -

totalUnvestedBalance Money? -

totalVestedBalance Money? -

userClassification string? - Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities Endpoints:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>POST accounts</ul><li>GET dataExtracts/userData</li>Applicable Values

valuationType string? - The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners. Aggregated / Manual: Manual Applicable containers: realEstate Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: DataExtractsEvent

Fields

data DataExtractsEventData? -

info string? -

yodlee: DataExtractsEventData

Fields

fromDate string? -

toDate string? -

userCount int? -

userData DataExtractsEventUserData[]? -

yodlee: DataExtractsEventLinks

Fields

href string? -

methodType string? -

rel string? -

yodlee: DataExtractsEventResponse

Fields

event DataExtractsEvent? -

yodlee: DataExtractsEventUserData

Fields

links DataExtractsEventLinks[]? -

user DataExtractsUser? -

yodlee: DataExtractsHolding

Fields

accountId int? - Unique identifier of the account to which the security is linked. Applicable containers: investment, insurance

accruedIncome Money? -

accruedInterest Money? -

contractQuantity decimal? - The quantity of tradeable units in a contract. Note: The contract quantity field is only applicable to commodity and currency. Applicable containers: investment

costBasis Money? -

couponRate decimal? - The stated interest rate for a bond. Applicable containers: investment

createdDate string? - The date on which the holding is created in the Yodlee system. Applicable containers: investment, insurance

cusipNumber string? - The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada. Applicable containers: investment

description string? - The description (name) for the holding (E.g., Cisco Systems) For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

enrichedDescription string? - The enrichedDescription is the security description of the normalized holding Applicable containers: investment, insurance

exercisedQuantity decimal? - The quantity of the employee stock options that are already exercised or bought by the employee. Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options. Applicable containers: investment

expirationDate string? - The date on which an option, right or warrant expires. Note: The expiration date field is only applicable to options and employee stock options. Applicable containers: investment

grantDate string? - The date on which equity awards like ESOP, RSU, etc., are issued or granted. Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

holdingType string? - Type of holding Applicable containers: investment, insurance

id int? - Unique identifier for the security added in the system. This is the primary key of the holding resource. Applicable containers: investment, insurance

interestRate decimal? - The interest rate on a CD. Note: The interest rate field is only applicable to CD. Applicable containers: investment

isShort boolean? - Indicates that the holding is a short trading. Applicable containers: investment

isin string? - The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets. Note: The ISIN field is only applicable to the trade related transactions Applicable containers: investment

lastUpdated string? - The date when the information was last updated in the system. Applicable containers: investment, insurance

matchStatus string? - Indicates the security match status id of the investment option identified during security normalization. Applicable containers: investment

maturityDate string? - The stated maturity date of a bond or CD. Applicable containers: investment

optionType string? - The type of the option position (i.e., put or call). Note: The option type field is only applicable to options. Applicable containers: investment Applicable Values

price Money? -

providerAccountId int? - Unique identifier for the user's association with the provider. Applicable containers: investment, insurance

quantity decimal? - The quantity held for the holding. Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity. For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

securityStyle string? - Indicates the security style of holding identified through the security service. Applicable containers: investment, insurance

securityType string? - Indicates the security type of holding identified through the security service. Applicable containers: investment, insurance

sedol string? - The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes. Note: The SEDOL field is only applicable to the trade related transactions Applicable containers: investment

spread Money? -

strikePrice Money? -

symbol string? - The symbol of the security. Applicable containers: investment

term string? - The fixed duration for which the bond or CD is issued. Note: The term field is only applicable to CD. Applicable containers: investment

unvestedQuantity decimal? - Indicates the number of unvested quantity or units. Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

unvestedValue Money? -

value Money? -

vestedQuantity decimal? - The quantity of units or shares that are already vested on a vest date. Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedSharesExercisable decimal? - The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity. Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedValue Money? -

vestingDate string? - The date on which a RSU, RSA, or an employee stock options become vested. Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

yodlee: DataExtractsProviderAccount

Fields

aggregationSource string? - The source through which the providerAccount is added in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

createdDate string? - The date on when the provider account is created in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

id int? - Unique identifier for the provider account resource. This is created during account addition. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

isDeleted boolean? - Indicates if the provider account is deleted from the system.Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates whether account is a manual or aggregated provider account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - Indicate when the providerAccount is last updated successfully. Account Type: Aggregated Endpoints:<ul><li>GET dataExtracts/userData</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

providerId int? - Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

requestId string? - Unique id generated to indicate the request. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

status string? - The status of last update attempted for the account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: DataExtractsTransaction

Fields

CONTAINER string? - The account's container. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

accountId int? - The account from which the transaction was made. This is basically the primary key of the account resource. Applicable containers: bank,creditCard,investment,insurance,loan

amount Money? -

baseType string? - Indicates if the transaction appears as a debit or a credit transaction in the account. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

category string? - The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

categoryId int? - The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

categorySource string? - Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

categoryType string? - The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

checkNumber string? - The checkNumber of the transaction. Applicable containers: bank

commission Money? -

createdDate string? -

cusipNumber string? - The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada. Note: The CUSIP number field applies only to trade related transactions. Applicable containers: investment

date string? - The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site. Applicable containers: bank,creditCard,investment,insurance,loan

description Description? -

detailCategoryId int? - The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories. Applicable containers: bank,creditCard

highLevelCategoryId int? - The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

holdingDescription string? - For transactions involving securities, this captures the securities description. Applicable containers: investment

id int? - An unique identifier for the transaction. The combination of the id and account container are unique in the system. Applicable containers: bank,creditCard,investment,insurance,loan

interest Money? -

isDeleted boolean? - Indicates if the transaction is marked as deleted.Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. Applicable containers: bank,creditCard,investment,insurance,loan

isin string? - International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities. Applicable containers: investment

lastUpdated string? -

memo string? - Additional notes provided by the user for a particular transaction through application or API services. Applicable containers: bank,creditCard,investment,insurance,loan

merchant Merchant? -

parentCategoryId int? - The parentCategoryId of the category assigned to the transaction. Note: This field will be provided in the response if the transaction is assigned to a user-created category. Applicable containers: bank,creditCard,investment,insurance,loan

postDate string? - The date on which the transaction is posted to the account. Applicable containers: bank,creditCard,insurance,loan

price Money? -

principal Money? -

quantity decimal? - The quantity associated with the transaction. Note: The quantity field applies only to trade-related transactions. Applicable containers: investment

runningBalance Money? -

sedol string? - SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes. Applicable containers: investment

settleDate string? - It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date. Applicable containers: investment

sourceId string? - A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

sourceType string? - The source through which the transaction is added to the Yodlee system. Applicable containers: bank,creditCard,investment,insurance,loann Applicable Values:

status string? - The status of the transaction: pending or posted. Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

subType string? - The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card. Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India. Applicable containers: bank,creditCard,investment,insurance,loan

symbol string? - The symbol of the security being traded. Note: The settle date field applies only to trade-related transactions. Applicable containers: investment

transactionDate string? - The date the transaction happens in the account. Applicable containers: bank,creditCard,investment,insurance,loan

'type string? - The nature of the transaction, i.e., deposit, refund, payment, etc. Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites. Applicable containers: bank,creditCard,investment

valoren string? - It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland. Applicable containers: investment

yodlee: DataExtractsUser

Fields

loginName string? -

yodlee: DataExtractsUserData

Fields

account DataExtractsAccount[]? -

holding DataExtractsHolding[]? -

providerAccount DataExtractsProviderAccount[]? -

totalTransactionsCount int? -

'transaction DataExtractsTransaction[]? -

user DataExtractsUser? -

yodlee: DataExtractsUserDataResponse

Fields

userData DataExtractsUserData[]? -

yodlee: DerivedCategorySummary

Fields

categoryId int? - Id of the category. This information is provided by transactions/categories service. Applicable containers: creditCard, bank, investment

categoryName string? - The name of the category. Applicable containers: creditCard, bank, investment

creditTotal Money? -

debitTotal Money? -

details DerivedCategorySummaryDetails[]? - Credit and debit summary per date. Applicable containers: creditCard, bank, investment

links DerivedTransactionsLinks? -

yodlee: DerivedCategorySummaryDetails

Fields

creditTotal Money? -

date string? - Date on which the credit and debit transactions had occured. Applicable containers: creditCard, bank, investment

debitTotal Money? -

yodlee: DerivedHolding

Fields

accountId int? - Unique identifier of the account to which the security is linked. Applicable containers: investment, insurance

accruedIncome Money? -

accruedInterest Money? -

assetClassification AssetClassification? -

contractQuantity decimal? - The quantity of tradeable units in a contract. Note: The contract quantity field is only applicable to commodity and currency. Applicable containers: investment

costBasis Money? -

couponRate decimal? - The stated interest rate for a bond. Applicable containers: investment

createdDate string? - The date on which the holding is created in the Yodlee system. Applicable containers: investment, insurance

cusipNumber string? - The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada. Applicable containers: investment

description string? - The description (name) for the holding (E.g., Cisco Systems) For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

enrichedDescription string? - The enrichedDescription is the security description of the normalized holding Applicable containers: investment, insurance

exercisedQuantity decimal? - The quantity of the employee stock options that are already exercised or bought by the employee. Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options. Applicable containers: investment

expirationDate string? - The date on which an option, right or warrant expires. Note: The expiration date field is only applicable to options and employee stock options. Applicable containers: investment

grantDate string? - The date on which equity awards like ESOP, RSU, etc., are issued or granted. Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

holdingType string? - Type of holding Applicable containers: investment, insurance

id int? - Unique identifier for the security added in the system. This is the primary key of the holding resource. Applicable containers: investment, insurance

interestRate decimal? - The interest rate on a CD. Note: The interest rate field is only applicable to CD. Applicable containers: investment

isShort boolean? - Indicates that the holding is a short trading. Applicable containers: investment

isin string? - The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets. Note: The ISIN field is only applicable to the trade related transactions Applicable containers: investment

lastUpdated string? - The date when the information was last updated in the system. Applicable containers: investment, insurance

matchStatus string? - Indicates the security match status id of the investment option identified during security normalization. Applicable containers: investment

maturityDate string? - The stated maturity date of a bond or CD. Applicable containers: investment

optionType string? - The type of the option position (i.e., put or call). Note: The option type field is only applicable to options. Applicable containers: investment Applicable Values

price Money? -

providerAccountId int? - Unique identifier for the user's association with the provider. Applicable containers: investment, insurance

quantity decimal? - The quantity held for the holding. Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity. For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

securityStyle string? - Indicates the security style of holding identified through the security service. Applicable containers: investment, insurance

securityType string? - Indicates the security type of holding identified through the security service. Applicable containers: investment, insurance

sedol string? - The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes. Note: The SEDOL field is only applicable to the trade related transactions Applicable containers: investment

spread Money? -

strikePrice Money? -

symbol string? - The symbol of the security. Applicable containers: investment

term string? - The fixed duration for which the bond or CD is issued. Note: The term field is only applicable to CD. Applicable containers: investment

unvestedQuantity decimal? - Indicates the number of unvested quantity or units. Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

unvestedValue Money? -

value Money? -

vestedQuantity decimal? - The quantity of units or shares that are already vested on a vest date. Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedSharesExercisable decimal? - The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity. Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedValue Money? -

vestingDate string? - The date on which a RSU, RSA, or an employee stock options become vested. Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

yodlee: DerivedHoldingsAccount

Fields

id int? - The primary key of the account resource and the unique identifier for the account. Required Feature Enablement: Asset classification feature. Applicable containers: investment, insurance

value Money? -

yodlee: DerivedHoldingsLinks

Fields

holdings string? -

yodlee: DerivedHoldingsSummary

Fields

account DerivedHoldingsAccount[]? - Accounts that contribute to the classification. Required Feature Enablement: Asset classification feature. Applicable containers: investment, insurance

classificationType string? - The classification type of the security. The supported asset classification type and the values are provided in the /holdings/assetClassificationList. Required Feature Enablement: Asset classification feature. Applicable containers: investment, insurance

classificationValue string? - The classification value that corresponds to the classification type of the holding. The supported asset classification type and the values are provided in the /holdings/assetClassificationList. Required Feature Enablement: Asset classification feature. Applicable containers: investment, insurance

holding DerivedHolding[]? - Securities that belong to the asset classification type and contributed to the summary value. Required Feature Enablement: Asset classification feature. Applicable containers: investment, insurance

value Money? -

yodlee: DerivedHoldingSummaryResponse

Fields

holdingSummary DerivedHoldingsSummary[]? -

link DerivedHoldingsLinks? -

yodlee: DerivedNetworth

Fields

asset Money? -

date string? - The date as of when the networth information is provided. Applicable containers: bank, creditcard, investment, insurance, realEstate, loan

historicalBalances DerivedNetworthHistoricalBalance[]? - Balances of the accounts over the period of time. Applicable containers: bank, creditcard, investment, insurance, realEstate, loan

liability Money? -

networth Money? -

yodlee: DerivedNetworthHistoricalBalance

Fields

accountId int? -

asOfDate string? - Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system. Account Type: Aggregated and Manual Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>

balance Money? -

dataSourceType string? - The source of balance information. Account Type: Aggregated and Manual Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>Applicable Values

date string? - Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance. AdditIonal Details: scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates. carryForward : Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc. calculated: Balances that gets calculated for the days that are prior to the account added date. Account Type: Aggregated and Manual Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li><li>GET derived/networth</li></ul>

isAsset boolean? - Indicates whether the balance is an asset or liability. Account Type: Aggregated and Manual Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>

yodlee: DerivedNetworthResponse

Fields

networth DerivedNetworth[]? -

yodlee: DerivedTransactionsLinks

Fields

transactions string? - Link of the transaction API service that corresponds to the value derivation. Applicable containers: creditCard, bank, investment

yodlee: DerivedTransactionsSummary

Fields

categorySummary DerivedCategorySummary[]? - Summary of transaction amouts at category level. Applicable containers: creditCard, bank, investment

categoryType string? - Type of categories provided by transactions/categories service. Applicable containers: creditCard, bank, investment Applicable Values

creditTotal Money? -

debitTotal Money? -

links DerivedTransactionsLinks? -

yodlee: DerivedTransactionSummaryResponse

Fields

links DerivedTransactionsLinks? -

transactionSummary DerivedTransactionsSummary[]? -

yodlee: Description

Fields

consumer string? - The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field. Applicable containers: creditCard, insurance, loan

original string? - Original transaction description as it appears at the FI site. Applicable containers: creditCard, insurance, loan

security string? - The description will provide the actual name of the security. Applicable containers: investment

simple string? - The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field.Note: The simple description field is available only in the United States, Canada, United Kingdom, and India. Applicable containers: creditCard, insurance, loan

yodlee: DetailCategory

Fields

id int? - The unique identifier of the detail category. Applicable containers: creditCard, investment, insurance, loan

name string? - The name of the detail category Applicable containers: creditCard, investment, insurance, loan

yodlee: Document

Fields

accountID int? - The unique identifier for the account. The account ID to which the document is linked. Applicable containers: bank, investment, creditCard, loan, insurance

docType string? - Indicates the type of the document. Applicable containers: bank, investment, creditCard, loan, insurance

formType string? - Indicates the type of the tax form. Applicable containers: bank, investment, creditCard, loan, insurance

id string? - The document's primary key and unique identifier. Applicable containers: bank, investment, creditCard, loan, insurance

lastUpdated string? - Indicates the date and time the document was last updated. Applicable containers: bank, investment, creditCard, loan, insurance

name string? - Indicates the name of the document. Applicable containers: bank, investment, creditCard, loan, insurance

'source string? - Indicates the source of the document download. Applicable containers: bank, investment, creditCard, loan, insurance

status string? - Indicates the status of the document download. Applicable containers: bank, investment, creditCard, loan, insurance

yodlee: DocumentDownload

Fields

docContent string? - Contents of the document in Base64 format. Applicable containers: bank, investment, creditCard, loan, insurance

id string? - The document's primary key and unique identifier. Applicable containers: bank, investment, creditCard, loan, insurance

yodlee: DocumentDownloadResponse

Fields

document DocumentDownload[]? -

yodlee: DocumentResponse

Fields

document Document[]? -

yodlee: Email

Fields

'type string? -

value string? -

yodlee: EvaluateAccountAddress

Fields

address1 string? -

address2 string? -

address3 string? -

city string? -

country string? -

sourceType string? -

state string? -

street string -

'type string? -

zip string? -

yodlee: EvaluateAddressRequest

Fields

address EvaluateAccountAddress -

yodlee: EvaluateAddressResponse

Fields

address AccountAddress[]? -

isValidAddress boolean? -

yodlee: Field

Fields

id string? - Identifier for the field. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

image string? - Image displayed at the endsite. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>

isOptional boolean? - Indicates if a field is an optional field or a mandatory field. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

isValueProvided boolean? - Indicates that the answer to the security question already exists in the Yodlee system.Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided. Endpoints:<ul><li>GET providerAccounts?include=questions</li><li>GET providerAccounts/{providerAccountId}? include=questions</li></ul>

maxLength int? - The maximum length of the login form field. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

minLength int? - The minimum length of the login form field. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

name string? - Name of the field. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

option Option[]? - Provides the different values that are available for the user to choose. This field is applicable for drop-down or radio field types. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

prefix string? - The prefix string that has to be displayed before the field value. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

suffix string? - The suffix string that has to be displayed next to the field value. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

'type string? - This indicates the display type of the field. For example, text box, image, etc. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>Applicable Values

value string? - Value expected from the user for the field. This will be blank and is expected to be filled and sent back when submitting the login or MFA information. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

valueEditable string? - Indicates whether the field is editable or not. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

yodlee: FieldOperation

Fields

'field string? - Field for which the clause is created. Applicable containers: bank, creditCard, investment, insurance, loan Applicable Values:<ul><li>amount</li><li>description</li></ul>Applicable Values

operation string? - Operation for which the clause is created. Applicable containers: bank, creditCard, investment, insurance, loan Applicable values (depends on the value of field):<ul><li>field is description -> operation can be<ol><li>stringEquals</li><li>stringContains</li></ol></li><li>field is amount -> operation can be<ol><li>numberEquals</li><li>numberLessThan</li><li>numberLessThanEquals</li><li>numberGreaterThan</li><li>numberGreaterThanEquals</li></ol></li></ul>Applicable Values

value record {}? - The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause. Applicable containers: bank, creditCard, investment, insurance, loan Applicable Values:<ul><li>field is description -> value should be min of 3 and max of 50 characters</li><li>field is amount -> value should be min value of 0 and a max value of 99999999999.99</li></ul>

yodlee: FullAccountNumberList

Fields

paymentAccountNumber string? - Payment Account Number of given account. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

unmaskedAccountNumber string? - Unmasked account number of given account. Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

yodlee: HistoricalBalance

Fields

asOfDate string? - Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system. Aggregated / Manual: Both Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>

balance Money? -

dataSourceType string? - The source of balance information. Aggregated / Manual: Both Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>Applicable Values

date string? - Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance. Additional Details: Scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates. CarryForward: Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc. calculated: Balances that gets calculated for the days that are prior to the account added date. Aggregated / Manual: Both Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li><li>GET derived/networth</li></ul>

isAsset boolean? - Indicates whether the balance is an asset or liability. Aggregated / Manual: Both Applicable containers: bank, creditCard, investment, insurance, realEstate, loan Endpoints:<ul><li>GET accounts/historicalBalances</li></ul>

yodlee: Holding

Fields

accountId int? - Unique identifier of the account to which the security is linked. Applicable containers: investment, insurance

accruedIncome Money? -

accruedInterest Money? -

assetClassification AssetClassification[]? - Asset classification applied to the holding. Applicable containers: investment

contractQuantity decimal? - The quantity of tradeable units in a contract. Note: The contract quantity field is only applicable to commodity and currency. Applicable containers: investment

costBasis Money? -

couponRate decimal? - The stated interest rate for a bond. Applicable containers: investment

createdDate string? - The date on which the holding is created in the Yodlee system. Applicable containers: investment, insurance

cusipNumber string? - The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada. Applicable containers: investment

description string? - The description (name) for the holding (E.g., Cisco Systems) For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

enrichedDescription string? - The enrichedDescription is the security description of the normalized holding Applicable containers: investment, insurance

exercisedQuantity decimal? - The quantity of the employee stock options that are already exercised or bought by the employee. Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options. Applicable containers: investment

expirationDate string? - The date on which an option, right or warrant expires. Note: The expiration date field is only applicable to options and employee stock options. Applicable containers: investment

grantDate string? - The date on which equity awards like ESOP, RSU, etc., are issued or granted. Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

holdingType string? - Type of holding Applicable containers: investment, insurance

id int? - Unique identifier for the security added in the system. This is the primary key of the holding resource. Applicable containers: investment, insurance

interestRate decimal? - The interest rate on a CD. Note: The interest rate field is only applicable to CD. Applicable containers: investment

isShort boolean? - Indicates that the holding is a short trading. Applicable containers: investment

isin string? - The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets. Note: The ISIN field is only applicable to the trade related transactions Applicable containers: investment

lastUpdated string? - The date when the information was last updated in the system. Applicable containers: investment, insurance

matchStatus string? - Indicates the security match status id of the investment option identified during security normalization. Applicable containers: investment

maturityDate string? - The stated maturity date of a bond or CD. Applicable containers: investment

optionType string? - The type of the option position (i.e., put or call). Note: The option type field is only applicable to options. Applicable containers: investment Applicable Values

price Money? -

providerAccountId int? - Unique identifier for the user's association with the provider. Applicable containers: investment, insurance

quantity decimal? - The quantity held for the holding. Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity. For insurance container, the field is only applicable for insurance annuity and variable life insurance types. Applicable containers: investment, insurance

securityStyle string? - Indicates the security style of holding identified through the security service. Applicable containers: investment, insurance

securityType string? - Indicates the security type of holding identified through the security service. Applicable containers: investment, insurance

sedol string? - The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes. Note: The SEDOL field is only applicable to the trade related transactions Applicable containers: investment

spread Money? -

strikePrice Money? -

symbol string? - The symbol of the security. Applicable containers: investment

term string? - The fixed duration for which the bond or CD is issued. Note: The term field is only applicable to CD. Applicable containers: investment

unvestedQuantity decimal? - Indicates the number of unvested quantity or units. Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

unvestedValue Money? -

value Money? -

vestedQuantity decimal? - The quantity of units or shares that are already vested on a vest date. Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedSharesExercisable decimal? - The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity. Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

vestedValue Money? -

vestingDate string? - The date on which a RSU, RSA, or an employee stock options become vested. Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc. Applicable containers: investment

yodlee: HoldingAssetClassificationListResponse

Fields

assetClassificationList AssetClassificationList[]? -

yodlee: HoldingResponse

Fields

holding Holding[]? -

yodlee: HoldingSecuritiesResponse

Fields

holding SecurityHolding[]? -

yodlee: HoldingTypeListResponse

Fields

holdingType string[]? -

yodlee: Identifier

Fields

'type string? - Type of Identifier

value string? - Value of the identifier

yodlee: LoanPayoffDetails

Fields

outstandingBalance Money? -

payByDate string? - The date by which the payoff amount should be paid. Account Type: Aggregated Applicable containers: loan Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

payoffAmount Money? -

yodlee: LoginForm

Fields

forgetPasswordURL string? - The forget password URL of the provider site. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

formType string? - The type of the forms for which the user information is required. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>Applicable Values

help string? - The help that can be displayed to the customer in the login form. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

id int? - The identifier of the login form. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

loginHelp string? - The help that can be displayed to the customer in the login form. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

mfaInfoText string? - The text displayed in the provider site while requesting the user's MFA information. This field is applicable for MFA form types only. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>

mfaInfoTitle string? - The title for the MFA information demanded from the user.This is the title displayed in the provider site.This field is applicable for MFA form types only. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>

mfaTimeout int? - The amount of time before which the user is expected to provide MFA information. This field is applicable for MFA form types only. This would be an useful information that could be displayed to the users. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

row Row[]? - This indicates one row in the form. The row will have one label. But it may have single or multiple fields. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

yodlee: Merchant

Fields

address AccountAddress? -

categoryLabel string[]? - The business categories of the merchant. Applicable containers: bank,creditCard Applicable Values

contact Contact? -

coordinates Coordinates? -

id string? - Identifier of the merchant. Applicable containers: bank,creditCard,investment,insurance,loan

name string? - The name of the merchant. Applicable containers: bank,creditCard,investment,insurance,loan

'source string? - The source through which merchant information is retrieved. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

website string? - The website of the merchant. Applicable containers: bank,creditCard,investment,loan

yodlee: Money

Fields

amount decimal -

currency string -

yodlee: Name

Fields

first string? -

fullName string? -

last string? -

middle string? -

yodlee: Option

Fields

displayText string? - The text that is displayed to the user for that option in the provider site. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

isSelected boolean? - The option that is selected by default in the provider site. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

optionValue string? - The value that is associated with the option. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

yodlee: PaymentBankTransferCode

Fields

id string? - Value of the identifier

'type string? - Type of BankTransferCode

yodlee: PaymentIdentifier

Fields

'type string? - Type of Identifier

value string? - Value of the identifier

yodlee: PaymentProfile

Fields

address AccountAddress[]? - The address of the lender to which the monthly payments or the loan payoff amount should be paid. Additional Details:The address field applies only to the student loan account type. Account Type: Aggregated Applicable containers: loan Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

identifier PaymentIdentifier? -

paymentBankTransferCode PaymentBankTransferCode? -

yodlee: PhoneNumber

Fields

'type string? - type of phone number

value string? - Phone Number

yodlee: Profile

Fields

address AccountAddress[]? - Address available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

email Email[]? - Email Id available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

gender string? - Gender of the provider account holder. Aggregated / Manual: Aggregated Endpoints:<ul><li>GET providerAccounts/profile</li></ul>

identifier Identifier[]? - Identifiers available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

name Name? -

phoneNumber PhoneNumber[]? - Phone number available in the profile page of the account. Account Type: Aggregated Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>

yodlee: ProviderAccount

Fields

aggregationSource string? - The source through which the providerAccount is added in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

consentId int? - Consent Id generated through POST Consent. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

createdDate string? - The date on when the provider account is created in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

id int? - Unique identifier for the provider account resource. This is created during account addition. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates whether account is a manual or aggregated provider account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - Indicate when the providerAccount is last updated successfully. Account Type: Aggregated Endpoints:<ul><li>GET dataExtracts/userData</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

preferences ProviderAccountPreferences? -

providerId int? - Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

requestId string? - Unique id generated to indicate the request. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

status string? - The status of last update attempted for the account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: ProviderAccountDetail

Fields

aggregationSource string? - The source through which the providerAccount is added in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

consentId int - Consent Id generated through POST Consent. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

createdDate string? - The date on when the provider account is created in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

id int? - Unique identifier for the provider account resource. This is created during account addition. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates whether account is a manual or aggregated provider account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - Indicate when the providerAccount is last updated successfully. Account Type: Aggregated Endpoints:<ul><li>GET dataExtracts/userData</li></ul>

loginForm LoginForm[]? - This entity gets returned in the response for only MFA based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of MFA form that is displayed to the user in the provider site. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

preferences ProviderAccountPreferences? -

providerId int? - Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

requestId string? - Unique id generated to indicate the request. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

status string? - The status of last update attempted for the account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: ProviderAccountDetailResponse

Fields

providerAccount ProviderAccountDetail[]? -

yodlee: ProviderAccountPreferences

Fields

isAutoRefreshEnabled boolean? - Indicates if auto-refreshes have to be triggered for the provider account. Endpoints:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>

isDataExtractsEnabled boolean? - Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service. Endpoints:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>

linkedProviderAccountId int? - LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account. LinkedProviderAccountId and the providerAccountId belongs to the same institution. Endpoints:<ul><li>POST Provider Account</li><li>PUT Provider Account</li><li>GET Provider Accounts</li></ul>

yodlee: ProviderAccountPreferencesRequest

Fields

preferences ProviderAccountPreferences? -

yodlee: ProviderAccountProfile

Fields

id int? - Unique identifier for profile Endpoints:<ul><li>GET providerAccounts/profile</li></ul>

profile Profile[]? - PII related data like address, name, phoneNumber, identifier and email. Endpoints:<ul><li>GET providerAccounts/profile</li></ul>

yodlee: ProviderAccountRequest

Fields

aggregationSource string? -

consentId int? - Consent Id generated for the request through POST Consent. Endpoints:<ul><li>POST Provider Account</li><li>PUT Provider Account</li></ul>

dataset ProvidersDataset[]? -

datasetName string[]? -

'field Field[] -

preferences ProviderAccountPreferences? -

yodlee: ProviderAccountResponse

Fields

providerAccount ProviderAccount[]? -

yodlee: ProviderAccountUserProfileResponse

Fields

providerAccount ProviderAccountProfile[]? -

yodlee: ProviderDetail

Fields

PRIORITY string? - Indicates the priority for which the service is invoked. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

accountType string[]? - AccountType supported by the provider, eg: Brokerage Cash, Current Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

associatedProviderIds int[]? - The screen-scraping providers that are associated to the Open Banking provider ID. Applicable containers: All Containers Endpoints:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>

authParameter string[]? - AuthParameter appears in the response only in case of token-based aggregation sites. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

authType string? - The authentication type enabled at the provider site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

baseUrl string? - The base URL of the provider's site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

capability Capability[]? - Capability of the site Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul> Note : capability has been deprecated

countryISOCode string? - Country to which the provider belongs. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

dataset ProvidersDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

favicon string? - Favicon link of the provider. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

help string? - Text to guide user through linking an account that belongs to the site Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

id int? - Unique identifier for the provider site(e.g., financial institution sites, biller sites, lender sites, etc.). Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isAddedByUser string? - Indicates that the site has been added by the user at least once. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isAutoRefreshEnabled boolean? - Indicates if a provider site is auto-refreshed. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isConsentRequired boolean? - Indicates if a provider site requires consent. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

languageISOCode string? - The language in which the provider details are provided. For example, a site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user's locale. The language follows the two letter ISO code. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

lastModified string? - Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

loginForm LoginForm[]? - This entity represents the structure of the login or MFA form that is displayed to the user at the provider site. For performance reasons, this field is returned only when a single provider is requested in the request. Endpoints:<ul><li>GET providers/{providerId}</li></ul>

loginUrl string? - The login URL of the provider's site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

logo string? - The logo link of the provider institution. The link will return the logo in the PNG format. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

name string? - The name of a provider site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

primaryLanguageISOCode string? - The primary language of the site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

status string? - Determines if the provider is supported for the cobrand (customer), is in the beta stage, etc. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

yodlee: ProviderDetailResponse

Fields

provider ProviderDetail[]? -

yodlee: ProviderResponse

Fields

provider Providers[]? -

yodlee: Providers

Fields

PRIORITY string? - Indicates the priority for which the service is invoked. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

accountType string[]? - AccountType supported by the provider, eg: Brokerage Cash, Current Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

associatedProviderIds int[]? - The screen-scraping providers that are associated to the Open Banking provider ID. Applicable containers: All Containers Endpoints:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>

authParameter string[]? - AuthParameter appears in the response only in case of token-based aggregation sites. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

authType string? - The authentication type enabled at the provider site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

baseUrl string? - The base URL of the provider's site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

capability Capability[]? - Capability of the site Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul> Note : capability has been deprecated

countryISOCode string? - Country to which the provider belongs. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

dataset ProvidersDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

favicon string? - Favicon link of the provider. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

forgetPasswordUrl string? - The forget password URL of the provider site. Endpoints:<ul><li>GET providers</li></ul>

help string? - Text to guide user through linking an account that belongs to the site Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

id int? - Unique identifier for the provider site(e.g., financial institution sites, biller sites, lender sites, etc.). Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isAddedByUser string? - Indicates that the site has been added by the user at least once. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isAutoRefreshEnabled boolean? - Indicates if a provider site is auto-refreshed. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

isConsentRequired boolean? - Indicates if a provider site requires consent. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

languageISOCode string? - The language in which the provider details are provided. For example, a site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user's locale. The language follows the two letter ISO code. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

lastModified string? - Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

loginHelp string? - Help text to guide the user to choose the correct provider site. Endpoints:<ul><li>GET providers</li></ul>

loginUrl string? - The login URL of the provider's site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

logo string? - The logo link of the provider institution. The link will return the logo in the PNG format. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

name string? - The name of a provider site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

primaryLanguageISOCode string? - The primary language of the site. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

status string? - Determines if the provider is supported for the cobrand (customer), is in the beta stage, etc. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

yodlee: ProvidersCount

Fields

TOTAL TotalCount? -

yodlee: ProvidersCountResponse

Fields

provider ProvidersCount? -

yodlee: ProvidersDataset

Fields

attribute Attribute[]? - The name of the dataset attribute suported by the provider. Endpoints:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>

name string? - The name of the dataset requested from the provider site Account Type: Manual Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li><li>GET providers</li></ul>Applicable Values

yodlee: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

yodlee: RewardBalance

Fields

balance decimal? - The actual reward balance. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

balanceToLevel string? - The balance required to reach a reward level. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

balanceToReward string? - The balance required to qualify for a reward such as retaining membership, business reward, etc. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

balanceType string? - The type of reward balance. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

description string? - The description for the reward balance as available at provider source. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

expiryDate string? - The date on which the balance expires. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

units string? - Unit of reward balance - miles, points, segments, dollars, credits. Account Type: Aggregated Applicable containers: reward Endpoints:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>

yodlee: Row

Fields

'field Field[]? - Details of fields that belong to the row. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

fieldRowChoice string? - Fields that belong to a particular choice are collected together using this field. Recommendations: All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. First field choice could be selected by default. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

form string? - Form denotes the set of the fields that are related. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

id string? - Unique identifier of the row. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

label string? - The label text displayed for a row in the form. Endpoints:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>

yodlee: RuleClause

Fields

'field string? - Field for which the clause is created. Valid Values:amount,descriptionApplicable containers: creditCard, investment, insurance, loan

fieldValue string? - The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause. Applicable containers: creditCard, investment, insurance, loan

operation string? - Operation for which the clause is created. Applicable containers: creditCard, investment, insurance, loan

ruleClauseId int? - Unique identifier generated for the rule clause. Applicable containers: creditCard, investment, insurance, loan

userDefinedRuleId int? - Unique identifier generated for every rule the user creates. Applicable containers: creditCard, investment, insurance, loan

yodlee: Security

Fields

accrualMethod string? - The method in which interest is accrued or earned. Applicable containers: investment, insurance

agencyFactor decimal? - Agency factor of the security. Applicable containers: investment, insurance

callDate string? - Next call date of the security. Applicable containers: investment, insurance

callPrice decimal? - Next call price of the security. Applicable containers: investment, insurance

cdscFundFlag boolean? - cdsc fund flag of the security. Applicable containers: investment, insurance

closedFlag boolean? - true:Closed for all investors , false: Open to all investors. Applicable containers: investment, insurance

cusip string? - A CUSIP is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. Applicable containers: investment, insurance

description string? - The description (name) of the security. For example, Cisco Systems. Applicable containers: investment, insurance

federalTaxable boolean? - Flag indicating federal taxable. Applicable containers: investment, insurance

firmEligible string? - 1- indicates Eligible,0- indicates firm is not eligible. Applicable containers: investment, insurance

firstCouponDate string? - First coupon date of security. Applicable containers: investment, insurance

frequency int? - Coupon Frequency. Applicable containers: investment, insurance

fundFamily string? - Mutual Fund Family Name. Applicable containers: investment, insurance

gicsSector string? - GICS Sector is a categorization the S&P assigns to all publically traded companies. Applicable containers: investment, insurance

id int? - The unique identifier of the security. Applicable containers: investment, insurance

incomeCurrency string? - ISO 4217 currency code indicating income currency of the security. Applicable containers: investment, insurance

interestRate decimal? - The rate of interest paid annually, expressed as a percentage of the bond's par or face value. Applicable containers: investment, insurance

isDummySecurity boolean? - Indicates whether the security is a dummy security. Applicable containers: investment, insurance

isEnvestnetDummySecurity boolean? - Flag indicating a dummy security. Applicable containers: investment, insurance

isSyntheticSecurity boolean? - Indicates whether the security is a simulated security. Applicable containers: investment, insurance

isin string? - The International Securities Identification Number (ISIN) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets. Applicable containers: investment, insurance

issueDate string? - Issue date of the security. Applicable containers: investment, insurance

issueTypeMultiplier decimal? - Price units corresponding to the security style. This is used to derive actual price of the security from market value. Applicable containers: investment, insurance

lastCouponDate string? - Last coupon date of security. Applicable containers: investment, insurance

lastModifiedDate string? - The last updated date of the security. Applicable containers: investment, insurance

maturityDate string? - Maturity date of the security. Applicable containers: investment, insurance

minimumPurchase int? - Minimum purchase of security. Applicable containers: investment, insurance

moodyRating string? - Unique identifier for Moody rating on Envestnet platform. Applicable containers: investment, insurance

sAndPRating string? - Unique identifier for S&P rating on Envestnet platform. Applicable containers: investment, insurance

sector string? - Identifier of the sector to which the security belongs to. Applicable containers: investment, insurance

sedol string? - The Stock Exchange Daily Official List (SEDOL) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes. Note: The SEDOL field is only applicable to the trade related transactions. Applicable containers: investment, insurance

shareClass string? - Share class of the security. Applicable containers: investment, insurance

stateTaxable boolean? - The state in which the security is taxed. Applicable containers: investment, insurance

stockExchangeDetails StockExchangeDetail[]? - Securities exchange provide the securities information at the corresponding exchanges. Applicable containers: investment, insurance

style string? - Classification of the style for the security. Applicable containers: investment, insurance

subSector string? - GICS sector ID to which the security belongs to. Applicable containers: investment, insurance

tradeCurrencyCode string? - ISO 4217 currency code indicating trading currency of the security. Applicable containers: investment, insurance

'type string? - Indicates the type of security like stocks, mutual fund, etc. Applicable containers: investment, insurance

yodlee: SecurityHolding

Fields

id string? -

security Security? -

yodlee: Statement

Fields

accountId int? - Account to which the statement belongs to. Applicable containers: creditCard, loan, insurance

amountDue Money? -

apr decimal? - The APR applied to the balance on the credit card account, as available in the statement. Note: In case of variable APR, the APR available on the statement might differ from the APR available at the account-level. Applicable containers: creditCard, loan, insurance

billingPeriodEnd string? - The end date of the statement period. Applicable containers: creditCard, loan, insurance

billingPeriodStart string? - The start date of the statement period. Applicable containers: creditCard, loan, insurance

cashAdvance Money? -

cashApr decimal? - The APR applicable to cash withdrawals on the credit card account. Applicable containers: creditCard, loan, insurance

dueDate string? - The date by when the minimum payment is due to be paid. Note: The due date that appears in the statement may differ from the due date at the account-level. Applicable containers: creditCard, loan, insurance

id int? - Unique identifier for the statement. Applicable containers: creditCard, loan, insurance

interestAmount Money? -

isLatest boolean? - The field is set to true if the statement is the latest generated statement. Applicable containers: creditCard, loan, insurance

lastPaymentAmount Money? -

lastPaymentDate string? - The date on which the last payment was done during the billing cycle. Applicable containers: creditCard, loan, insurance

lastUpdated string? - The date when the account was last updated by Yodlee. Applicable containers: creditCard, loan, insurance

loanBalance Money? -

minimumPayment Money? -

newCharges Money? -

principalAmount Money? -

statementDate string? - The date on which the statement is generated. Applicable containers: creditCard, loan, insurance

yodlee: StatementResponse

Fields

statement Statement[]? -

yodlee: StockExchangeDetail

Fields

countryCode string? - Country codes are geocodes developed to represent countries and dependent areas. Applicable containers: investment, insurance

currencyCode string? - ISO codes of currency. Applicable containers: investment, insurance

exchangeCode string? - An Exchange code is a four-character code used to identify stock markets and other trading exchanges within global trading. Applicable containers: investment, insurance

symbol string? - Ticker symbol representing particular securities listed on an exchange. Applicable containers: investment, insurance

yodlee: TotalCount

Fields

count int? -

yodlee: Transaction

Fields

CONTAINER string? - The account's container. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

accountId int? - The account from which the transaction was made. This is basically the primary key of the account resource. Applicable containers: bank,creditCard,investment,insurance,loan

amount Money? -

baseType string? - Indicates if the transaction appears as a debit or a credit transaction in the account. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

category string? - The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

categoryId int? - The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

categorySource string? - Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

categoryType string? - The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

checkNumber string? - The checkNumber of the transaction. Applicable containers: bank

commission Money? -

createdDate string? -

cusipNumber string? - The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada. Note: The CUSIP number field applies only to trade related transactions. Applicable containers: investment

date string? - The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site. Applicable containers: bank,creditCard,investment,insurance,loan

description Description? -

detailCategoryId int? - The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories. Applicable containers: bank,creditCard

highLevelCategoryId int? - The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. Applicable containers: bank,creditCard,investment,insurance,loan

holdingDescription string? - For transactions involving securities, this captures the securities description. Applicable containers: investment

id int? - An unique identifier for the transaction. The combination of the id and account container are unique in the system. Applicable containers: bank,creditCard,investment,insurance,loan

interest Money? -

isManual boolean? - Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. Applicable containers: bank,creditCard,investment,insurance,loan

isin string? - International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities. Applicable containers: investment

lastUpdated string? -

memo string? - Additional notes provided by the user for a particular transaction through application or API services. Applicable containers: bank,creditCard,investment,insurance,loan

merchant Merchant? -

parentCategoryId int? - The parentCategoryId of the category assigned to the transaction. Note: This field will be provided in the response if the transaction is assigned to a user-created category. Applicable containers: bank,creditCard,investment,insurance,loan

postDate string? - The date on which the transaction is posted to the account. Applicable containers: bank,creditCard,insurance,loan

price Money? -

principal Money? -

quantity decimal? - The quantity associated with the transaction. Note: The quantity field applies only to trade-related transactions. Applicable containers: investment

runningBalance Money? -

sedol string? - SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes. Applicable containers: investment

settleDate string? - It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date. Applicable containers: investment

sourceId string? - A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

sourceType string? - The source through which the transaction is added to the Yodlee system. Applicable containers: bank,creditCard,investment,insurance,loann Applicable Values:

status string? - The status of the transaction: pending or posted. Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

subType string? - The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card. Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India. Applicable containers: bank,creditCard,investment,insurance,loan

symbol string? - The symbol of the security being traded. Note: The settle date field applies only to trade-related transactions. Applicable containers: investment

transactionDate string? - The date the transaction happens in the account. Applicable containers: bank,creditCard,investment,insurance,loan

'type string? - The nature of the transaction, i.e., deposit, refund, payment, etc. Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites. Applicable containers: bank,creditCard,investment

valoren string? - It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland. Applicable containers: investment

yodlee: TransactionCategorizationRule

Fields

categoryLevelId int? - The level of the category for which the rule is created. Applicable containers: creditCard, insurance, loan

memId int? - Unique identifier of the user. Applicable containers: creditCard, investment, insurance, loan

ruleClauses RuleClause[]? - Details of rules. Applicable containers: creditCard, investment, insurance, loan

rulePriority int? - The order in which the rules get executed on transactions. Applicable containers: creditCard, investment, insurance, loan

transactionCategorisationId int? - Category id that is assigned to the transaction when the transaction matches the rule clause. This is the id field of the transaction category resource. Applicable containers: creditCard, investment, insurance, loan

userDefinedRuleId int? - Unique identifier generated for every rule the user creates. Applicable containers: creditCard, investment, insurance, loan

yodlee: TransactionCategorizationRuleInfo

Fields

categoryId int -

priority int? -

ruleClause FieldOperation[] -

'source string? -

yodlee: TransactionCategorizationRuleRequest

Fields

rule TransactionCategorizationRuleInfo -

yodlee: TransactionCategorizationRuleResponse

Fields

txnRules TransactionCategorizationRule[]? -

yodlee: TransactionCategory

Fields

category string? - The name of the category. Note: Transaction categorization is one of the core features offered by Yodlee and the categories are assigned to the transactions by the system. Transactions can be clubbed together by the category that is assigned to them. Applicable containers: creditCard, investment, insurance, loan

classification string? - Category Classification. Applicable containers: creditCard, investment, insurance, loan Applicable Values

defaultCategoryName string? - A attribute which will always hold the first value(initial name) of Yodlee defined category attribute. Applicable containers: creditCard, investment, insurance, loan

defaultHighLevelCategoryName string? - A attribute which will always hold the first value(initial name) of Yodlee defined highLevelCategoryName attribute. Applicable containers: creditCard, investment, insurance, loan

detailCategory DetailCategory[]? - Entity that provides detail category attributes Applicable containers: creditCard, investment, insurance, loan

highLevelCategoryId int? - The unique identifier of the high level category. Applicable containers: creditCard, investment, insurance, loan

highLevelCategoryName string? - The name of the high level category. A group of similar transaction categories are clubbed together to form a high-level category. Applicable containers: creditCard, investment, insurance, loan

id int? - Unique identifier of the category. Applicable containers: creditCard, investment, insurance, loan

'source string? - Source used to identify whether the transaction category is user defined category or system created category. Applicable containers: creditCard, investment, insurance, loan Applicable Values

'type string? - Transaction categories and high-level categories are further mapped to five transaction category types. Customers, based on their needs can either use the transaction categories, the high-level categories, or the transaction category types. Applicable containers: creditCard, investment, insurance, loan Applicable Values

yodlee: TransactionCategoryRequest

Fields

categoryName string? -

parentCategoryId int -

'source string? -

yodlee: TransactionCategoryResponse

Fields

transactionCategory TransactionCategory[]? -

yodlee: TransactionCount

Fields

TOTAL TransactionTotal? -

yodlee: TransactionCountResponse

Fields

'transaction TransactionCount? -

yodlee: TransactionDays

Fields

fullAccountNumberFields string[]? -

numberOfTransactionDays int? -

yodlee: TransactionRequest

Fields

'transaction UpdateTransaction -

yodlee: TransactionResponse

Fields

'transaction Transaction[]? -

yodlee: TransactionTotal

Fields

count int? -

yodlee: UpdateAccountInfo

Fields

accountName string? -

accountNumber string? -

accountStatus string? -

address AccountAddress? -

amountDue Money? -

balance Money? -

container string? -

dueDate string? -

frequency string? -

homeValue Money? -

includeInNetWorth string? -

isEbillEnrolled string? -

memo string? -

nickname string? -

yodlee: UpdateAccountRequest

Fields

account UpdateAccountInfo -

yodlee: UpdateCategoryRequest

Fields

categoryName string? -

highLevelCategoryName string? -

id int -

'source string -

yodlee: UpdateCobrandNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET cobrand/config/notifications/events</li></ul>

yodlee: UpdateCobrandNotificationEventRequest

Fields

event UpdateCobrandNotificationEvent -

yodlee: UpdateConfigsNotificationEvent

Fields

callbackUrl string? - URL to which the notification should be posted. Endpoints:<ul><li>GET configs/notifications/events</li></ul>

yodlee: UpdateConfigsNotificationEventRequest

Fields

event UpdateConfigsNotificationEvent -

yodlee: UpdatedProviderAccount

Fields

aggregationSource string? - The source through which the providerAccount is added in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

createdDate string? - The date on when the provider account is created in the system. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

dataset AccountDataset[]? - Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

id int? - Unique identifier for the provider account resource. This is created during account addition. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

isManual boolean? - Indicates whether account is a manual or aggregated provider account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

lastUpdated string? - Indicate when the providerAccount is last updated successfully. Account Type: Aggregated Endpoints:<ul><li>GET dataExtracts/userData</li></ul>

loginForm LoginForm[]? - This entity gets returned in the response for only MFA based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of MFA form that is displayed to the user in the provider site. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

oauthMigrationStatus string? - Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. Endpoints:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

providerId int? - Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>

requestId string? - Unique id generated to indicate the request. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>

status string? - The status of last update attempted for the account. Endpoints:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>Applicable Values

yodlee: UpdatedProviderAccountResponse

Fields

providerAccount UpdatedProviderAccount[]? -

yodlee: UpdateTransaction

Fields

categoryId int -

categorySource string -

container string -

description Description? -

memo string? -

yodlee: UpdateUserRegistration

Fields

address UserAddress? -

email string? -

name Name? -

preferences UserRequestPreferences? -

segmentName string? -

yodlee: UpdateUserRequest

Fields

user UpdateUserRegistration -

yodlee: UpdateVerification

Fields

account VerificationAccount? -

accountId int? - Unique identifier for the account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

providerAccountId int? - Unique identifier for the provider account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

reason string? - The reason the account verification failed. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

'transaction VerificationTransaction[] -

verificationDate string? - The date of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationId int? - Unique identifier for the verification request. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationStatus string? - The status of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

verificationType string? - The account verification type. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

yodlee: UpdateVerificationRequest

Fields

verification UpdateVerification? -

yodlee: User

Fields

id int? - The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for. Endpoints:<ul><li>POST user/samlLogin</li><li>POST user/register</li><li>GET user</li></ul>

loginName string? - The login name of the user used for authentication. Endpoints:<ul><li>POST user/register</li><li>GET user</li></ul>

name Name? -

preferences UserResponsePreferences? -

roleType string? -

session UserSession? -

yodlee: UserAccessToken

Fields

accessTokens AccessTokens[]? -

yodlee: UserAccessTokensResponse

Fields

user UserAccessToken? -

yodlee: UserAddress

Fields

address1 string? -

address2 string? -

address3 string? -

city string? -

country string? -

state string? -

zip string? -

yodlee: UserDetail

Fields

address UserAddress? -

email string? - The email address of the user. Endpoints:<ul><li>GET user</li></ul>

id int? - The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for. Endpoints:<ul><li>POST user/samlLogin</li><li>POST user/register</li><li>GET user</li></ul>

loginName string? - The login name of the user used for authentication. Endpoints:<ul><li>POST user/register</li><li>GET user</li></ul>

name Name? -

preferences UserResponsePreferences? -

roleType string? -

segmentName string? -

yodlee: UserDetailResponse

Fields

user UserDetail? -

yodlee: UserRegistration

Fields

address UserAddress? -

email string? -

loginName string -

name Name? -

preferences UserRequestPreferences? -

segmentName string? -

yodlee: UserRequest

Fields

user UserRegistration -

yodlee: UserRequestPreferences

Fields

currency string? - The currency of the user. This currency will be respected while providing the response for derived API services. Applicable Values

dateFormat string? - The dateformat of the user.This attribute is just a place holder and has no impact on any other API services.

locale string? - The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services. Applicable Values

timeZone string? - The timezone of the user. This attribute is just a place holder and has no impact on any other API services.

yodlee: UserResponse

Fields

user User? -

yodlee: UserResponsePreferences

Fields

currency string? - The currency of the user. This currency will be respected while providing the response for derived API services. Applicable Values

dateFormat string? - The dateformat of the user.This attribute is just a place holder and has no impact on any other API services.

locale string? - The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services. Applicable Values

timeZone string? - The timezone of the user. This attribute is just a place holder and has no impact on any other API services.

yodlee: UserSession

Fields

userSession string? - Session provided for a valid user to access API services upon successful authentication. Endpoints:<ul><li>POST user/samlLogin</li><li>POST user/register</li></ul>

yodlee: Verification

Fields

account VerificationAccount? -

accountId int? - Unique identifier for the account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

providerAccountId int? - Unique identifier for the provider account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

reason string? - The reason the account verification failed. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationDate string? - The date of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationId int? - Unique identifier for the verification request. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationStatus string? - The status of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

verificationType string? - The account verification type. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

yodlee: VerificationAccount

Fields

accountName string? -

accountNumber string -

accountType string -

bankTransferCode VerificationBankTransferCode -

yodlee: VerificationBankTransferCode

Fields

id string? - The FI's branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). Account Type: Aggregated Applicable containers: bank, investment Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>

'type string? - The bank transfer code type varies depending on the region of the account origination. Account Type: Aggregated Applicable containers: bank, investment Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>Applicable Values

yodlee: VerificationRequest

Fields

verification Verification -

yodlee: VerificationResponse

Fields

verification Verification[]? -

yodlee: VerificationStatus

Fields

account VerificationAccount? -

accountId int? - Unique identifier for the account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

providerAccountId int? - Unique identifier for the provider account. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

reason string? - The reason the account verification failed. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

remainingAttempts int? -

verificationDate string? - The date of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationId int? - Unique identifier for the verification request. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul>

verificationStatus string? - The status of the account verification. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

verificationType string? - The account verification type. Endpoints:<ul><li>POST verification</li><li>GET verification</li><li>PUT verification</li></ul> Applicable Values

yodlee: VerificationStatusResponse

Fields

verification VerificationStatus[]? -

yodlee: VerificationTransaction

Fields

amount Money -

baseType string -

yodlee: VerifiedAccount

Fields

accountNumber string? - The account number as it appears on the site. (The POST accounts service response return this field as number) Additional Details: Bank/ Loan/ Insurance/ Investment: The account number for the bank account as it appears at the site. Credit Card: The account number of the card account as it appears at the site, i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it. Applicable containers: All Containers Aggregated / Manual: Both Endpoints: <ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST accounts</li></ul>

accountType string? - The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account. Valid Values: Aggregated Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PPF</li><li>RECURRING_DEPOSIT</li><li>FSA</li><li>MONEY_MARKET</li><li>IRA</li><li>PREPAID</li></ul>creditCard<ul><li>OTHER</li><li>CREDIT</li><li>STORE</li><li>CHARGE</li><li>OTHER</li></ul>investment (SN 1.0)<ul><li>BROKERAGE_MARGIN</li><li>HSA</li><li>IRA</li><li>BROKERAGE_CASH</li><li>401K</li><li>403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE</li><li>CUSTODIAL</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE</li><li>JTTIC</li><li>JTWROS</li><li>COMMUNITY_PROPERTY</li><li>JOINT_BY_ENTIRETY</li><li>CONSERVATORSHIP</li><li>ROTH</li><li>ROTH_CONVERSION</li><li>ROLLOVER</li><li>EDUCATIONAL</li><li>529_PLAN</li><li>457_DEFERRED_COMPENSATION</li><li>401A</li><li>PSP</li><li>MPP</li><li>STOCK_BASKET</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER</li><li>CHARITABLE_LEAD</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP</li><li>UTMA</li><li>UGMA</li><li>ESOPP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>SOLE_PROPRIETORSHIP</li><li>CHURCH</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CMA</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET</li><li>SUPER_ANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN</li><li>DEFERRED_PROFIT_SHARING_PLAN</li><li>NON_REGISTERED_SAVINGS_PLAN</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN</li><li>GROUP_RETIREMENT_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_ACCOUNT</li><li>REGISTERED_PENSION_PLAN</li><li>TAX_FREE_SAVINGS_ACCOUNT</li><li>LIFE_INCOME_FUND</li><li>REGISTERED_RETIREMENT_INCOME_FUND</li><li>SPOUSAL_RETIREMENT_INCOME_FUND</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND</li><li>GUARANTEED_INVESTMENT_CERTIFICATES</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN</li><li>OTHER</li></ul>investment (SN 2.0)<ul><li>BROKERAGE_CASH</li><li>BROKERAGE_MARGIN</li><li>INDIVIDUAL_RETIREMENT_ACCOUNT_IRA</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_401K</li><li>EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE_IRA</li><li>CUSTODIAL_ACCOUNT</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE_INVESTMENT_ACCOUNT</li><li>JOINT_TENANTS_TENANCY_IN_COMMON_JTIC</li><li>JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS</li><li>JOINT_TENANTS_COMMUNITY_PROPERTY</li><li>JOINT_TENANTS_TENANTS_BY_ENTIRETY</li><li>CONSERVATOR</li><li>ROTH_IRA</li><li>ROTH_CONVERSION</li><li>ROLLOVER_IRA</li><li>EDUCATIONAL</li><li>EDUCATIONAL_SAVINGS_PLAN_529</li><li>DEFERRED_COMPENSATION_PLAN_457</li><li>MONEY_PURCHASE_RETIREMENT_PLAN_401A</li><li>PROFIT_SHARING_PLAN</li><li>MONEY_PURCHASE_PLAN</li><li>STOCK_BASKET_ACCOUNT</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER_TRUST</li><li>CHARITABLE_LEAD_TRUST</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP_IRA</li><li>UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA</li><li>UNIFORM_GIFT_TO_MINORS_ACT_UGMA</li><li>EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>PROPRIETORSHIP</li><li>CHURCH_ACCOUNT</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CASH_MANAGEMENT_ACCOUNT</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET_ACCOUNT</li><li>SUPERANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP</li><li>DEFERRED_PROFIT_SHARING_PLAN_DPSP</li><li>NON_REGISTERED_SAVINGS_PLAN_NRSP</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN_RESP</li><li>GROUP_RETIREMENT_SAVINGS_PLAN_GRSP</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP</li><li>LOCKED_IN_RETIREMENT_ACCOUNT_LIRA</li><li>REGISTERED_PENSION_PLAN_RPP</li><li>TAX_FREE_SAVINGS_ACCOUNT_TFSA</li><li>LIFE_INCOME_FUND_LIF</li><li>REGISTERED_RETIREMENT_INCOME_FUND_RIF</li><li>SPOUSAL_RETIREMENT_INCOME_FUND_SRIF</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF</li><li>GUARANTEED_INVESTMENT_CERTIFICATES_GIC</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP</li><li>DEFINED_CONTRIBUTION_PLAN</li><li>DEFINED_BENEFIT_PLAN</li><li>EMPLOYEE_STOCK_OPTION_PLAN</li><li>NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A</li><li>KEOGH_PLAN</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K</li><li>DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP</li><li>EMPLOYEE_BENEFIT_PLAN</li><li>EMPLOYEE_SAVINGS_PLAN</li><li>HEALTH_SAVINGS_ACCOUNT_HSA</li><li>COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA</li><li>TESTAMENTARY_TRUST</li><li>ESTATE</li><li>GRANTOR_RETAINED_ANNUITY_TRUST_GRAT</li><li>ADVISORY_ACCOUNT</li><li>NON_PROFIT_ORGANIZATION_501C</li><li>HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA</li><li>INDIVIDUAL_SAVINGS_ACCOUNT_ISA</li><li>CASH_ISA</li><li>STOCKS_AND_SHARES_ISA</li><li>INNOVATIVE_FINANCE_ISA</li><li>JUNIOR_ISA</li><li>EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO</li><li>PUBLIC_PROVIDENT_FUND_PPF</li><li>EMPLOYEES_PENSION_SCHEME_EPS</li><li>NATIONAL_PENSION_SYSTEM_NPS</li><li>INDEXED_ANNUITY</li><li>ANNUITIZED_ANNUITY</li><li>VARIABLE_ANNUITY</li><li>ROTH_403B</li><li>SPOUSAL_IRA</li><li>SPOUSAL_ROTH_IRA</li><li>SARSEP_IRA</li><li>SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP</li><li>OFFSHORE_TRUST</li><li>IRREVOCABLE_LIFE_INSURANCE_TRUST</li><li>INTERNATIONAL_TRUST</li><li>LIFE_INTEREST_TRUST</li><li>EMPLOYEE_BENEFIT_TRUST</li><li>PRECIOUS_METAL_ACCOUNT</li><li>INVESTMENT_LOAN_ACCOUNT</li><li>GRANTOR_RETAINED_INCOME_TRUST</li><li>PENSION_PLAN</li><li>OTHER</li></ul>loan<ul><li>MORTGAGE</li><li>INSTALLMENT_LOAN</li><li>PERSONAL_LOAN</li><li>HOME_EQUITY_LINE_OF_CREDIT</li><li>LINE_OF_CREDIT</li><li>AUTO_LOAN</li><li>STUDENT_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>AUTO_INSURANCE</li><li>HEALTH_INSURANCE</li><li>HOME_INSURANCE</li><li>LIFE_INSURANCE</li><li>ANNUITY</li><li>TRAVEL_INSURANCE</li><li>INSURANCE</li></ul>realEstate<ul> <li>REAL_ESTATE</li></ul>reward<ul><li>REWARD_POINTS</li></ul>Manual Account Type bank<ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PREPAID</li></ul>credit<ul> <li>CREDIT</li></ul>loan<ul> <li>PERSONAL_LOAN</li><li>HOME_LOAN</li></ul>insurance<ul><li>INSURANCE</li><li>ANNUITY</li></ul>investment<ul><li>BROKERAGE_CASH</li></ul> Aggregated / Manual: Both Applicable containers: All containers </ul>

bankTransferCode BankTransferCode[]? - Bank and branch identification information. Aggregated / Manual: Aggregated Applicable containers: bank, investment, loan Endpoints: <ul></ul>

fullAccountNumber string? -

holder AccountHolder[]? -

id int? -

providerAccountId int? - The primary key of the provider account resource. Aggregated / Manual: Both Applicable containers: All containers

providerName string? - Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities

yodlee: VerifyAccount

Fields

account VerifiedAccount[]? -

transactionCriteria VerifyTransactionCriteria[]? -

yodlee: VerifyAccountRequest

Fields

accountId int? -

container string? -

transactionCriteria VerifyTransactionCriteria[] -

yodlee: VerifyAccountResponse

Fields

verifyAccount VerifyAccount? -

yodlee: VerifyTransactionCriteria

Fields

amount decimal -

baseType string? - Indicates if the transaction appears as a debit or a credit transaction in the account. Applicable containers: bank,creditCard,investment,insurance,loan Applicable Values

date string -

dateVariance string? -

keyword string? -

matched string? - Indicates if the criteria is matched or not. Applicable Values

verifiedTransaction Transaction[]? -

yodlee: YodleeError

Fields

errorCode string? -

errorMessage string? -

referenceCode string? -

Import

import ballerinax/yodlee;

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Finance/Asset Management

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.0 1.4.0 1.2.0 1.1.0

Dependencies

ballerina/url/2.2.3 ballerina/constraint/1.1.0 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

ballerinax/yodlee Ballerina library

Overview

Prerequisites

Clients

yodlee: Client

Constructor

getAllAccounts

Parameters

Return Type

createManualAccount

Parameters

Return Type

evaluateAddress

Parameters

Return Type

getHistoricalBalances

Parameters

Return Type

getAccount

Parameters

Return Type

updateAccount

Parameters

Return Type

deleteAccount

Parameters

Return Type

getApiKeys

Return Type

generateApiKey

Parameters

Return Type

deleteApiKey

Parameters

Return Type

generateAccessToken

Return Type

deleteToken

Return Type

getSubscribedEvents

Parameters

Return Type

Deprecated

updateSubscribedEvent

Parameters

Return Type

Deprecated

createSubscriptionEvent

Parameters

Return Type

Deprecated

deleteSubscribedEvent

Parameters

Return Type

Deprecated

cobrandLogin

Parameters

Return Type

cobrandLogout

Return Type

getPublicKey

Return Type

Deprecated

getSubscribedNotificationEvents

Parameters

Return Type

updateSubscribedNotificationEvent

Parameters

Return Type

createSubscriptionNotificationEvent

Parameters

Return Type

deleteSubscribedNotificationEvent

Parameters

Return Type

getPublicEncryptionKey

Return Type

getDataExtractsEvents