Yodlee Core APIs

Cobrand Login The cobrand login service authenticates a cobrand.Cobrand session in the response includes the cobrand session token (cobSession) which is used in subsequent API calls like registering or signing in the user. The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be invoked to create a new cobrand session token. Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.The content type has to be passed as application/json for the body parameter.

Cobrand Logout The cobrand logout service is used to log out the cobrand.This service does not return a response. The HTTP response code is 204 (Success with no content).Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.

Add Manual Account The add account service is used to add manual accounts.The response of add account service includes the account name , account number and Yodlee generated account id.All manual accounts added will be included as part of networth calculation by default.Add manual account support is available for bank, card, investment, insurance and loan container only.Note: A real estate account addition is only supported for SYSTEM and MANUAL valuation type.

Create or Run Transaction Categorization Rule The Create or Run Transaction Categorization Rule endpoint is used to: Create transaction categorization rules for both system and user-defined categories.Run all the transaction categorization rules to categorize transactions by calling the endpoint with action=run as the query parameter. The input body parameters to create transaction categorization rules follow: categoryId - This field is mandatory and numeric priority - This field is optional and numeric. Priority decides the order in which the rule gets applied on transactions. ruleClause - This field is mandatory and should contain at least one rule field - The value can be description or amount If the field value is description then, 1. operation - value can be stringEquals or stringContains 2. value - value should be min of 3 and max of 50 characters If the field value is amount then, 1. operation - value can be numberEquals, numberLessThan, numberLessThanEquals, numberGreaterThan or numberGreaterThanEquals 2. value - min value 0 and a max value of 99999999999.99 is allowedThe HTTP response code is 201 (Created Successfully).

Subscribe Event Refer POST /configs/notifications/events/{eventName}.The subscribe events service is used to subscribe to an event for receiving notifications.The callback URL, where the notification will be posted should be provided to this service.If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.Notes:This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.The content type has to be passed as application/json for the body parameter.

Subscribe For Notification Event The subscribe events service is used to subscribe to an event for receiving notifications.The callback URL, where the notification will be posted should be provided to this service.If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.Notes:This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.The content type has to be passed as application/json for the body parameter.

Create Category The create transaction categories service is used to create user-defined categories for a system-defined category.The parentCategoryId is the system-defined category id.This can be retrieved using get transaction categories service.The categoryName can accept minimum of 1, maximum of 50 alphanumeric or special characters.The HTTP response code is 201 (Created successfully).

Delete Account The delete account service allows an account to be deleted.This service does not return a response. The HTTP response code is 204 (Success with no content).

Delete API Key This endpoint allows an existing API key to be deleted.You can use one of the following authorization methods to access this API:cobsessionJWT token Notes: This service is not available in developer sandbox environment and will be made availablefor testing in your dedicated environment.

Delete Document The delete document service allows the consumer to delete a document. The deleted document will not be returned in the get documents API. The HTTP response code is 204 (success without content).Documents can be deleted only if the document related dataset attributes are subscribed.

Delete Provider Account The delete provider account service is used to delete a provider account from the Yodlee system. This service also deletes the accounts that are created in the Yodlee system for that provider account. This service does not return a response. The HTTP response code is 204 (Success with no content).

Delete Subscription Refer DELETE /configs/notifications/events/{eventName}.The delete events service is used to unsubscribe from an events service.

Delete Notification Subscription The delete events service is used to unsubscribe from an events service.

Delete Token This endpoint revokes the token passed in the Authorization header. This service is applicable for JWT-based (and all API key-based) authentication and also client credential (clientId and secret) based authentication. This service does not return a response body. The HTTP response code is 204 (success with no content). Tokens generally have limited lifetime of up to 30 minutes. You will call this service when you finish working with one user, and you want to delete the valid token rather than simply letting it expire.Note: Revoking an access token (either type, admin or a user token) can take up to 2 minutes, as the tokens are stored on a distributed system.

Delete Transaction Categorization Rule The delete transaction categorization rule service is used to delete the given user-defined transaction categorization rule for both system-defined category as well as user-defined category.This will delete all the corresponding rule clauses associated with the rule.The HTTP response code is 204 (Success without content).

Delete Category The delete transaction categories service is used to delete the given user-defined category.The HTTP response code is 204 (Success without content).

Download a Document The get document details service allows consumers to download a document. The document is provided in base64.This API is a premium service which requires subscription in advance to use. Please contact Yodlee Client Services for more information.

Update Account The update account API is used to: Retrieve the latest information for accounts that belong to one providerAccount from the provider site. You must allow at least 15 min between requests.Retrieve the latest information of all the eligible accounts that belong to the user.Data to be retrieved from the provider site can be overridden using datasetName or dataset. If you do pass datasetName, all the datasets that are implicitly configured for the dataset will be retrieved. This action is allowed for single provider account refresh flows only.Check the status of the providerAccount before invoking this API. Do not call this API to trigger any action on a providerAccount when an action is already in progress for the providerAccount.If the customer has subscribed to the REFRESH event notification and invoked this API, relevant notifications will be sent to the customer.A dataset may depend on another dataset for retrieval, so the response will include the requested and dependent datasets.Check all the dataset additional statuses returned in the response because the provider account status is drawn from the dataset additional statuses.Updating preferences using this API will trigger refreshes. The content type has to be passed as application/json for the body parameter.-----------------------------------------------------------------------------------------------------------------------------------------Update All Eligible Accounts - Notes:This API will trigger a refresh for all the eligible provider accounts(both OB and credential-based accounts).This API will not refresh closed, inactive, or UAR accounts, or accounts with refreshes in-progress or recently refreshed non-OB accounts.No parameters should be passed to this API to trigger this action.Do not call this API often. Our recommendation is to call this only at the time the user logs in to your app because it can hamper other API calls performance.The response only contains information for accounts that were refreshed. If no accounts are eligible for refresh, no response is returned.

Evaluate Address Use this service to validate the address before adding the real estate account.If the address is valid, the service will return the complete address information.The response will contain multiple addresses if the user-provided input matches with multiple entries in the vendor database.In the case of multiple matches, the user can select the appropriate address from the list and then invoke the add account service with the complete address.Note: Yodlee recommends to use this service before adding the real estate account to avoid failures.

Generate Access Token using client credential authentication.This service returns access tokens required to access Yodlee 1.1 APIs. These tokens are the simplest and easiest of several alternatives for authenticating with Yodlee servers.The most commonly used services obtain data specific to an end user (your customer). For these services, you need a user access token. These are simply tokens created with the user name parameter (loginName) set to the id of your end user. Note: You determine this id and you must ensure it's unique among all your customers. Each token issued has an associated user. The token passed in the http headers explicitly names the user referenced in that API call.Some of the APIs do administrative work, and don't reference an end user. One example of administrative work is key management. Another example is registering a new user explicitly, with POST /user/register call or subscribe to webhook, with POST /config/notifications/events/{eventName}. To invoke these, you need an admin access token. Create this by passing in your admin user login name in place of a regular user name.This service also allows for simplified registration of new users. Any time you pass in a user name not already in use, the system will automatically implicitly create a new user for you. This user will naturally have very few associated details. You can later provide additional user information by calling the PUT user/register service.Notes:The content type has to be passed as application/x-www-form-urlencoded.Upgrading to client credential authentication requires infrastructure reconfiguration. Customers wishing to switch from another authentication scheme to client credential authentication, please contact Yodlee Client Services.

Generate API Key This endpoint is used to generate an API key. The RSA public key you provide should be in 2048 bit PKCS#8 encoded format. A public key is a mandatory input for generating the API key.The public key should be a unique key. The apiKeyId you get in the response is what you should use to generate the JWT token. You can use one of the following authorization methods to accessthis API:cobsessionJWT token Alternatively, you can use base 64 encoded cobrandLogin and cobrandPassword in the Authorization header (Format: Authorization: Basic )Note:This service is not available in developer sandbox environment and will be made available for testing in your dedicated environment. The content type has to be passed as application/json for the body parameter.

Get Access Tokens The Get Access Tokens service is used to retrieve the access tokens for the application id(s) provided.URL in the response can be used to launch the application for which token is requested.Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.

Get Account Details The get account details service provides detailed information of an account.Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

Get Accounts The get accounts service provides information about accounts added by the user.By default, this service returns information for active and to be closed accounts.If requestId is provided, the accounts that are updated in the context of the requestId will be provided in the response.Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.fullAccountNumberList, PII (Personal Identifiable Information) and holder details are not available by default, as it is a premium feature that needs security approval. This will not be available for testing in Sandbox environment.

Get Provider Accounts The get provider accounts service is used to return all the provider accounts added by the user. This includes the failed and successfully added provider accounts.

Get Providers The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region. Searching for a provider using a routing number is applicable only to the USA and Canada regions.The valid values for priority are: 1. cobrand: Returns providers enabled for the cobrand (Default priority) 2. popular: Returns providers popular among users of the customerOnly the datasets, attributes, and containers that are enabled for the customer will be returned in the response.Input for the dataset$filter should adhere to the following expression:[.container[ OR ] OR .container[]] OR [ OR ]dataset$filter value examples:ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]BASIC_AGG_DATABASIC_AGG_DATA OR ACCT_PROFILEBASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ] The fullAcountNumberFields is specified to filter the providers that have paymentAccountNumber or unmaskedAccountNumber support in the FULL_ACCT_NUMBER dataset attribute.Examples for usage of fullAccountNumberFields dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=paymentAccountNumberdataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumberdataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumberThe skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively.The response header provides the links to retrieve the next and previous set of transactions.Note: In a product flow involving user interaction, Yodlee recommends invoking this service with filters.Without filters, the service may perform slowly as it takes a few minutes to return data in the response.The AuthParameter appears in the response only in case of token-based aggregation sites.The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.This service supports the localization feature and accepts locale as a header parameter.The capability has been deprecated in query parameter and response.

Get API Keys This endpoint provides the list of API keys that exist for a customer.You can use one of the following authorization methods to access this API:cobsessionJWT tokenNotes:This service is not available in developer sandbox environment and will be made available for testing in your dedicated environment.

Get Asset Classification List The get asset classifications list service is used to get the supported asset classifications. The response includes different classification types like assetClass, country, sector, style, etc. and the values corresponding to each type.

Get Events The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the dataExtracts page.You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.This service is only invoked with either admin access token or a cobrand session.

Get userData The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.The time difference between fromDate and toDate fields cannot be more than 60 minutes.By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.This service is only invoked with either admin access token or a cobrand session.Refer to dataExtracts page for more information.Note:This service supports the localization feature and accepts locale as a header parameter.

Get Documents The get documents service allows customers to search or retrieve metadata related to documents. The API returns the document as per the input parameters passed. If no date range is provided then all downloaded documents will be retrieved. Details of deleted documents or documents associated to closed providerAccount will not be returned. This API is a premium service which requires subscription in advance to use. Please contact Yodlee Client Services for more information.

Get Historical Balances The historical balances service is used to retrieve the historical balances for an account or a user.Historical balances are daily (D), weekly (W), and monthly (M). The interval input should be passed as D, W, and M to retrieve the desired historical balances. The default interval is daily (D). When no account id is provided, historical balances of the accounts that are active, to be closed, and closed are provided in the response. If the fromDate and toDate are not passed, the last 90 days of data will be provided. The fromDate and toDate should be passed in the YYYY-MM-DD format. The date field in the response denotes the date for which the balance is requested.includeCF needs to be sent as true if the customer wants to return carried forward balances for a date when the data is not available. asofDate field in the response denotes the date as of which the balance was updated for that account.When there is no balance available for a requested date and if includeCF is sent as true, the previous date for which the balance is available is provided in the response. When there is no previous balance available, no data will be sent.

Get Holding Summary The get holding summary service is used to get the summary of asset classifications for the user.By default, accounts with status as ACTIVE and TO BE CLOSED will be considered.If the include parameter value is passed as details then a summary with holdings and account information is returned.

Get Holding Type List The get holding types list service is used to get the supported holding types.The response includes different holding types such as future, moneyMarketFund, stock, etc. and it returns the supported holding types

Get Holdings The get holdings service is used to get the list of holdings of a user.Supported holding types can be employeeStockOption, moneyMarketFund, bond, etc. and is obtained using get holding type list service. Asset classifications for the holdings need to be requested through the "include" parameter.Asset classification information for holdings are not available by default, as it is a premium feature.

Get Networth Summary The get networth service is used to get the networth for the user.If the include parameter value is passed as details then networth with historical balances is returned.

Get Provider Details The get provider detail service is used to get detailed information including the login form for a provider.The response is a provider object that includes information such as name of the provider, provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.Only enabled datasets, attributes and containers gets returned in the response.Note:This service supports the localization feature and accepts locale as a header parameter.The capability has been deprecated in the response.

Get Provider Account Details The get provider account details service is used to learn the status of adding accounts and updating accounts.This service has to be called continuously to know the progress level of the triggered process. This service also provides the MFA information requested by the provider site.When include = credentials, questions is passed as input, the service returns the credentials (non-password values) and questions stored in the Yodlee system for that provider account. Note: The password and answer fields are not returned in the response.

Get User Profile Details The get provider accounts profile service is used to return the user profile details that are associated to the provider account.

Get Providers Count The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.The functionality of the input parameters remains the same as that of the GET /providers endpointNote: The capability has been deprecated in the query parameter.

Get Public Key The get public key service provides the public key that should be used to encrypt user credentials while invoking POST /providerAccounts and PUT /providerAccounts endpoints.This service will only work if the PKI (public key infrastructure) feature is enabled for the customer.Note: The key in the response is a string in PEM format.This endpoint is not available in the Sandbox environment and it is useful only if the PKI feature is enabled.

Get Public Key Refer GET /configs/publicKey.The get public key service provides the customer the public key that should be used to encrypt the user credentials before sending it to Yodlee.This endpoint is useful only for PKI enabled.

Get Security Details The get security details service is used to get all the security information for the holdings

Get Statements The statements service is used to get the list of statement related information. By default, all the latest statements of active and to be closed accounts are retrieved for the user. Certain sites do not have both a statement date and a due date. When a fromDate is passed as an input, all the statements that have the due date on or after the passed date are retrieved. For sites that do not have the due date, statements that have the statement date on or after the passed date are retrieved. The default value of "isLatest" is true. To retrieve historical statements isLatest needs to be set to false.

Get Subscribed Events Refer GET /configs/notifications/events.The get events service provides the list of events for which consumers subscribed to receive notifications.

Get Subscribed Notification Events The get events service provides the list of events for which consumers subscribed to receive notifications.

Get Transaction Category List The categories service returns the list of available transaction categories.High level category is returned in the response only if it is opted by the customer.When invoked by passing the cobrand session or admin access token, this service returns the supported transaction categories at the cobrand level. When invoked by passing the cobrand session and the user session or user access token, this service returns the transaction categories along with user-defined categories.Double quotes in the user-defined category name will be prefixed by backslashes (\) in the response, e.g. Toys "R" Us.Source and id are the primary attributes of the category entity.Note:This service supports the localization feature and accepts locale as a header parameter.

Get Transaction Categorization Rules The get transaction categorization rule service is used to get all the categorization rules.

Get Transaction Categorization Rules The get transaction categorization rule service is used to get all the categorization rules.

Get Transaction Summary The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.Notes: Details can be requested for only one system-defined categoryPassing categoryType is mandatory except when the groupBy value is CATEGORY_TYPEDates will not be respected for monthly, yearly, and weekly detailsWhen monthly details are requested, only the fromDate and toDate month will be respectedWhen yearly details are requested, only the fromDate and toDate year will be respectedFor weekly data points, details will be provided for every Sunday date available within the fromDate and toDateThis service supports the localization feature and accepts locale as a header parameter