Yodlee

Yodlee Core APIs

This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee supports the Java SDK and it is available here . You can generate a client SDK for Python, Java, JavaScript, PHP or other languages according to your development needs. For more details about the APIs, refer to Yodlee API v1.1 - Overview .

Endpoints 70

Accounts

  • GETGet Accounts/accounts?accountId=string&container=string&include=string&providerAccountId=string&requestId=string&status=stringThe get accounts service provides information about accounts added by the user.<br>By default, this service returns information for active and to be closed…
  • POSTAdd Manual Account/accountsThe add account service is used to add manual accounts.<br>The response of add account service includes the account name , account number and Yodlee generated…
  • POSTEvaluate Address/accounts/evaluateAddressUse this service to validate the address before adding the real estate account.<br>If the address is valid, the service will return the complete address…
  • GETGet Historical Balances/accounts/historicalBalances?accountId=string&fromDate=string&includeCF=true&interval=string&skip=0&toDate=string&top=0The historical balances service is used to retrieve the historical balances for an account or a user.<br>Historical balances are daily (D), weekly (W), and…
  • GETGet Account Details/accounts/:accountId?include=stringThe get account details service provides detailed information of an account.<br><br><b>Note:</b><li>fullAccountNumber is deprecated and is replaced with…
  • PUTUpdate Account/accounts/:accountIdThe update account service is used to update manual and aggregated accounts.<br>The HTTP response code is 204 (Success without content).<br>Update manual…
  • DELETEDelete Account/accounts/:accountIdThe delete account service allows an account to be deleted.<br>This service does not return a response. The HTTP response code is 204 (Success with no…

Auth

  • GETGet API Keys/auth/apiKeyThis endpoint provides the list of API keys that exist for a customer.<br>You can use one of the following authorization methods to access this…
  • POSTGenerate API Key/auth/apiKeyThis endpoint is used to generate an API key. The RSA public key you provide should be in 2048 bit PKCS#8 encoded format. <br>A public key is a mandatory…
  • DELETEDelete API Key/auth/apiKey/:keyThis endpoint allows an existing API key to be deleted.<br>You can use one of the following authorization methods to access this…
  • POSTGenerate Access Token/auth/token<b>Generate Access Token using client credential authentication.</b><br>This service returns access tokens required to access Yodlee 1.1 APIs. These tokens…
  • DELETEDelete Token/auth/tokenThis endpoint revokes the token passed in the Authorization header. This service is applicable for JWT-based (and all API key-based) authentication and also…

Cobrand

  • GETGet Subscribed Events/cobrand/config/notifications/events?eventName=REFRESHDeprecated. <b>Refer GET /configs/notifications/events.</b><br>The get events service provides the list of events for which consumers subscribed <br>to…
  • PUTUpdate Subscription/cobrand/config/notifications/events/:eventNameDeprecated. <b>Refer PUT /configs/notifications/events/{eventName}.</b><br>The update events service is used to update the callback URL.<br>If the callback…
  • POSTSubscribe Event/cobrand/config/notifications/events/:eventNameDeprecated. <b>Refer POST /configs/notifications/events/{eventName}.</b><br>The subscribe events service is used to subscribe to an event for receiving…
  • DELETEDelete Subscription/cobrand/config/notifications/events/:eventNameDeprecated. <b>Refer DELETE /configs/notifications/events/{eventName}.</b><br>The delete events service is used to unsubscribe from an events service.<br>
  • POSTCobrand Login/cobrand/loginThe cobrand login service authenticates a cobrand.<br>Cobrand session in the response includes the cobrand session token (cobSession) <br>which is used in…
  • POSTCobrand Logout/cobrand/logoutThe cobrand logout service is used to log out the cobrand.<br>This service does not return a response. The HTTP response code is 204 (Success with no…
  • GETGet Public Key/cobrand/publicKeyDeprecated. <b>Refer GET /configs/publicKey.</b><br>The get public key service provides the customer the public key that should be used to encrypt the user…

Configs

  • GETGet Subscribed Notification Events/configs/notifications/events?eventName=REFRESHThe get events service provides the list of events for which consumers subscribed to receive notifications. <br>
  • PUTUpdate Notification Subscription/configs/notifications/events/:eventNameThe update events service is used to update the callback URL.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an…
  • POSTSubscribe For Notification Event/configs/notifications/events/:eventNameThe subscribe events service is used to subscribe to an event for receiving notifications.<br>The callback URL, where the notification will be posted should…
  • DELETEDelete Notification Subscription/configs/notifications/events/:eventNameThe delete events service is used to unsubscribe from an events service.<br>
  • GETGet Public Key/configs/publicKeyThe get public key service provides the public key that should be used to encrypt user credentials while invoking POST /providerAccounts and PUT…

DataExtracts

  • GETGet Events/dataExtracts/events?eventName=string&fromDate=string&toDate=stringThe get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES…
  • GETGet userData/dataExtracts/userData?fromDate=string&loginName=string&toDate=stringThe 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…

Derived

  • GETGet Holding Summary/derived/holdingSummary?accountIds=string&classificationType=string&include=stringThe get holding summary service is used to get the summary of asset classifications for the user.<br>By default, accounts with status as ACTIVE and TO BE…
  • GETGet Networth Summary/derived/networth?accountIds=string&container=string&fromDate=string&include=string&interval=string&skip=0&toDate=string&top=0The get networth service is used to get the networth for the user.<br>If the include parameter value is passed as details then networth with historical…
  • GETGet Transaction Summary/derived/transactionSummary?accountId=string&categoryId=string&categoryType=string&fromDate=string&groupBy=string&include=string&includeUserCategory=true&interval=string&toDate=stringThe transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or…

Documents

  • GETGet Documents/documents?Keyword=string&accountId=string&docType=string&fromDate=string&toDate=stringThe get documents service allows customers to search or retrieve metadata related to documents. <br>The API returns the document as per the input parameters…
  • GETDownload a Document/documents/:documentIdThe get document details service allows consumers to download a document. The document is provided in base64.<br>This API is a premium service which requires…
  • DELETEDelete Document/documents/:documentIdThe 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…

Holdings

  • GETGet Holdings/holdings?accountId=string&assetClassification.classificationType=string&classificationValue=string&include=string&providerAccountId=stringThe get holdings service is used to get the list of holdings of a user.<br>Supported holding types can be employeeStockOption, moneyMarketFund, bond, etc. and…
  • GETGet Asset Classification List/holdings/assetClassificationListThe get asset classifications list service is used to get the supported asset classifications. <br>The response includes different classification types like…
  • GETGet Holding Type List/holdings/holdingTypeListThe get holding types list service is used to get the supported holding types.<br>The response includes different holding types such as future,…
  • GETGet Security Details/holdings/securities?holdingId=stringThe get security details service is used to get all the security information for the holdings<br>

ProviderAccounts

  • GETGet Provider Accounts/providerAccounts?include=string&providerIds=stringThe get provider accounts service is used to return all the provider accounts added by the user. <br>This includes the failed and successfully added provider…
  • PUTUpdate Account/providerAccounts?providerAccountIds=stringThe update account API is used to:<br> <ul><li>Retrieve the latest information for accounts that belong to one providerAccount from the provider site. You…
  • GETGet User Profile Details/providerAccounts/profile?providerAccountId=stringThe get provider accounts profile service is used to return the user profile details that are associated to the provider account. <br>
  • GETGet Provider Account Details/providerAccounts/:providerAccountId?include=string&requestId=stringThe get provider account details service is used to learn the status of adding accounts and updating accounts.<br>This service has to be called continuously…
  • DELETEDelete Provider Account/providerAccounts/:providerAccountIdThe 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…
  • PUTUpdate Preferences/providerAccounts/:providerAccountId/preferencesThis endpoint is used to update preferences like data extracts and auto refreshes without triggering refresh for the providerAccount.<br>Setting…

Providers

  • GETGet Providers/providers?capability=string&dataset$filter=string&fullAccountNumberFields=string&institutionId=0&name=string&priority=string&providerId=string&skip=0&top=0The 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…
  • GETGet Providers Count/providers/count?capability=string&dataset$filter=string&fullAccountNumberFields=string&name=string&priority=stringThe count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.<br>If you are…
  • GETGet Provider Details/providers/:providerIdThe get provider detail service is used to get detailed information including the login form for a provider.<br>The response is a provider object that…

Statements

  • GETGet Statements/statements?accountId=string&container=string&fromDate=string&isLatest=string&status=stringThe statements service is used to get the list of statement related information. <br>By default, all the latest statements of active and to be closed accounts…

Transactions

  • GETGet Transactions/transactions?accountId=string&baseType=string&categoryId=string&categoryType=string&container=string&detailCategoryId=string&fromDate=string&highLevelCategoryId=string&keyword=string&skip=0&toDate=string&top=0&type=stringThe Transaction service is used to get a list of transactions for a user.<br>By default, this service returns the last 30 days of transactions from today's…
  • GETGet Transaction Category List/transactions/categoriesThe categories service returns the list of available transaction categories.<br>High level category is returned in the response only if it is opted by the…
  • PUTUpdate Category/transactions/categoriesThe update transaction categories service is used to update the transaction category name<br>for a high level category, a system-defined category and a…
  • POSTCreate Category/transactions/categoriesThe create transaction categories service is used to create user-defined categories for a system-defined category.<br>The parentCategoryId is the…
  • GETGet Transaction Categorization Rules/transactions/categories/rulesDeprecated. The get transaction categorization rule service is used to get all the categorization rules.<br>
  • POSTCreate or Run Transaction Categorization Rule/transactions/categories/rules?action=string&ruleParam=stringThe Create or Run Transaction Categorization Rule endpoint is used to: <br>Create transaction categorization rules for both system and user-defined…
  • PUTUpdate Transaction Categorization Rule/transactions/categories/rules/:ruleIdThe update transaction categorization rule service is used to update a categorization rule for both system-defined category as well as user-defined…
  • POSTRun Transaction Categorization Rule/transactions/categories/rules/:ruleId?action=runThe run transaction categorization rule service is used to run a rule on transactions, to categorize the transactions.<br>The HTTP response code is 204…
  • DELETEDelete Transaction Categorization Rule/transactions/categories/rules/:ruleIdThe delete transaction categorization rule service is used to delete the given user-defined transaction categorization rule for both system-defined category…
  • GETGet Transaction Categorization Rules/transactions/categories/txnRulesThe get transaction categorization rule service is used to get all the categorization rules.<br>
  • DELETEDelete Category/transactions/categories/:categoryIdThe delete transaction categories service is used to delete the given user-defined category.<br>The HTTP response code is 204 (Success without content).<br>
  • GETGet Transactions Count/transactions/count?accountId=string&baseType=string&categoryId=string&categoryType=string&container=string&detailCategoryId=string&fromDate=string&highLevelCategoryId=string&keyword=string&toDate=string&type=stringThe count service provides the total number of transactions for a specific user depending on the input parameters passed.<br>If you are implementing…
  • PUTUpdate Transaction/transactions/:transactionIdThe update transaction service is used to update the category,consumer description, memo for a transaction.<br>The HTTP response code is 204 (Success without…

User

  • GETGet User Details/userThe get user details service is used to get the user profile information and the application preferences set at the time of user registration.<br>
  • PUTUpdate User Details/userThe update user details service is used to update user details like name, address, currency preference, etc.<br>Currency provided in the input will be…
  • GETGet Access Tokens/user/accessTokens?appIds=stringThe Get Access Tokens service is used to retrieve the access tokens for the application id(s) provided.<br>URL in the response can be used to launch the…
  • POSTUser Logout/user/logout<b>Deprecated</b>: This endpoint is deprecated for API Key-based authentication. The user logout service allows the user to log out of the application.<br>The…
  • POSTRegister User/user/registerThe register user service is used to register a user in Yodlee.<br>The loginName cannot include spaces and must be between 3 and 150 characters.<br>locale…
  • POSTSaml Login/user/samlLogin?issuer=string&samlResponse=string&source=stringThe SAML login service is used to authenticate system users with a SAML response.<br>A new user will be created with the input provided if that user isn't…
  • DELETEDelete User/user/unregisterThe delete user service is used to delete or unregister a user from Yodlee. <br>Once deleted, the information related to the users cannot be retrieved.…

Verification

  • GETGet Verification Status/verification?accountId=string&providerAccountId=string&verificationType=stringThe get verification status service is used to retrieve the verification status of all accounts for which the MS or CDV process has been initiated.<br>For the…
  • PUTVerify Challenge Deposit/verificationThe put verification service is used to complete the challenge deposit verification (CDV) process.<br>This service is used only by the customer of CDV…
  • POSTInitiaite Matching Service and Challenge Deposit/verificationThe post verification service is used to initiate the matching service (MS) and the challenge deposit account verification (CDV) process to verify account…

Verify Account

  • POSTVerify Accounts Using Transactions/verifyAccount/:providerAccountIdThe verify account service is used to verify the account's ownership by matching the transaction details with the accounts aggregated for the…

API details

Authentication
None declared in the description
Operations
70 operations on 50 pathsGET 34POST 16PUT 10DELETE 10
6 marked deprecated
Main resources
Transactions 13Accounts 7Cobrand 7User 7ProviderAccounts 6Auth 5Configs 5Holdings 4Derived 3Documents 3
Response formats
application/json;charset=utf-8
Description format
OpenAPI 3.0.1, API version 1.1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Yodlee Core APIs in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Yodlee Core APIs collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Accounts” (GET /accounts?accountId=string&container=string&include=string&providerAccountId=string&requestId=string&status=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Yodlee Core APIs?

This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform… It is listed under Finance & banking and has 70 endpoints.

Who publishes the Yodlee Core APIs?

It is listed from Yodlee's public API description (an OpenAPI document), not published by Yodlee on Swastik Codes. Anyone who controls yodlee.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Yodlee Core APIs?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Yodlee Core APIs have?

70 operations on 50 paths (34 GET, 16 POST, 10 PUT, 10 DELETE). The largest groups are Transactions, Accounts, Cobrand, User.

Is forking the Yodlee Core APIs free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.