openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 384 kB

JSON

{"openapi":"3.0.1","servers":[{"url":"/"}],"info":{"contact":{"email":"developer@yodlee.com"},"description":"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 <a href=\"https://developer.yodlee.com/java-sdk-overview \">here</a>. 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 <a href=\"https://developer.yodlee.com/docs/api/1.1/Overview\">Yodlee API v1.1 - Overview</a>.","license":{"name":"Yodlee Developer License","url":"https://developer.yodlee.com/terms/condition#_Services_1"},"termsOfService":"https://developer.yodlee.com/terms/condition","title":"Yodlee Core APIs","version":"1.1.0","x-apisguru-categories":["financial"],"x-origin":[{"format":"openapi","url":"https://developer.yodlee.com/sites/default/files/api_spec/coreapisoas3.yml","version":"3.0"}],"x-providerName":"yodlee.com"},"tags":[{"description":"Accounts API","name":"Accounts"},{"description":"Auth API","name":"Auth"},{"description":"Cobrand API","name":"Cobrand"},{"description":"Configs API","name":"Configs"},{"description":"DataExtracts API","name":"DataExtracts"},{"description":"Derived API","name":"Derived"},{"description":"Documents API","name":"Documents"},{"description":"Holdings API","name":"Holdings"},{"description":"Provider Accounts API","name":"ProviderAccounts"},{"description":"Providers API","name":"Providers"},{"description":"Statements API","name":"Statements"},{"description":"Transactions API","name":"Transactions"},{"description":"Users API","name":"User"},{"description":"Verification API","name":"Verification"},{"description":"Verify Account API","name":"Verify Account"}],"paths":{"/accounts":{"get":{"deprecated":false,"description":"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: <li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li><li>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.</li>","operationId":"getAllAccounts","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountIds.","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities","in":"query","name":"container","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.","in":"query","name":"include","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated providerAccountIds.","in":"query","name":"providerAccountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"The unique identifier that returns contextual data","in":"query","name":"requestId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED","in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for status Y800 : Invalid value for container Y800 : Invalid value for providerAccountId Y824 : The maximum number of accountIds permitted is 100"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Accounts","tags":["Accounts"]},"post":{"deprecated":false,"description":"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: <li>A real estate account addition is only supported for SYSTEM and MANUAL valuation type.</li>","operationId":"createManualAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountRequest"}}},"description":"accountParam","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CreatedAccountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountParam Y811 : Real Estate Property value already exists Y862 : The provided address is invalid, or the valuation is not available Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Add Manual Account","tags":["Accounts"]}},"/accounts/evaluateAddress":{"post":{"deprecated":false,"description":"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: <li>Yodlee recommends to use this service before adding the real estate account to avoid failures.</li>","operationId":"evaluateAddress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluateAddressRequest"}}},"description":"addressParam","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/EvaluateAddressResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y806 : Invalid input Y800 : Invalid value for zip Y812 : Required field/value - address missing in the request Y812 : Required field/value - street missing in the request Y812 : Required field/value - state & city / zip missing in the request"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Evaluate Address","tags":["Accounts"]}},"/accounts/historicalBalances":{"get":{"deprecated":false,"description":"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.","operationId":"getHistoricalBalances","parameters":[{"allowEmptyValue":false,"description":"accountId","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"from date for balance retrieval (YYYY-MM-DD)","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Consider carry forward logic for missing balances","in":"query","name":"includeCF","schema":{"type":"boolean"}},{"allowEmptyValue":false,"description":"D-daily, W-weekly or M-monthly","in":"query","name":"interval","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"skip (Min 0)","in":"query","name":"skip","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":false,"description":"toDate for balance retrieval (YYYY-MM-DD)","in":"query","name":"toDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"top (Max 500)","in":"query","name":"top","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AccountHistoricalBalancesResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId Y800 : Invalid value for fromDate Y800 : Invalid value for toDate Y809 : Invalid date range Y800 : Invalid value for interval Y802 : Future date not allowed"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Historical Balances","tags":["Accounts"]}},"/accounts/{accountId}":{"delete":{"deprecated":false,"description":"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). ","operationId":"deleteAccount","parameters":[{"description":"accountId","in":"path","name":"accountId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId Y807 : Resource not found Y868 : No action is allowed, as the data is being migrated to the Open Banking provider "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Account","tags":["Accounts"]},"get":{"deprecated":false,"description":"The get account details service provides detailed information of an account. Note:<li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li>","operationId":"getAccount","parameters":[{"description":"accountId","in":"path","name":"accountId","required":true,"schema":{"format":"int64","type":"integer"}},{"allowEmptyValue":false,"description":"profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.","in":"query","name":"include","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Account Details","tags":["Accounts"]},"put":{"deprecated":false,"description":"The update account service is used to update manual and aggregated accounts. The HTTP response code is 204 (Success without content). Update manual account support is available for bank, card, investment, insurance, loan, otherAssets, otherLiabilities and realEstate containers only. Note:<li> A real estate account update is only supported for SYSTEM and MANUAL valuation type.</li><li> Attribute isEbillEnrolled is deprecated as it is applicable for bill accounts only.</li>","operationId":"updateAccount","parameters":[{"description":"accountId","in":"path","name":"accountId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountRequest"}}},"description":"accountRequest","required":true},"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId Y800 : Invalid value for updateParam Y862 : The provided address is invalid, or the valuation is not available Y868 : No action is allowed, as the data is being migrated to the Open Banking provider Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update Account","tags":["Accounts"]}},"/auth/apiKey":{"get":{"deprecated":false,"description":"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: <ol><li>cobsession</li><li>JWT token</li></ol>Notes:<li>This service is not available in developer sandbox environment and will be made available for testing in your dedicated environment. ","operationId":"getApiKeys","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get API Keys","tags":["Auth"]},"post":{"deprecated":false,"description":"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 access this API: <ol><li>cobsession</li><li>JWT token</li></ol> Alternatively, you can use base 64 encoded cobrandLogin and cobrandPassword in the Authorization header (Format: Authorization: Basic <encoded value of cobrandLogin: cobrandPassword>) Note: <li>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.</li>","operationId":"generateApiKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyRequest"}}},"description":"apiKeyRequest","required":true},"responses":{"201":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for RS512 publicKey Y806 : Invalid input Y824 : The maximum number of apiKey permitted is 5 Y811 : publicKey value already exists"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Generate API Key","tags":["Auth"]}},"/auth/apiKey/{key}":{"delete":{"deprecated":false,"description":"This endpoint allows an existing API key to be deleted. You can use one of the following authorization methods to access this API: <ol><li>cobsession</li><li>JWT token</li></ol> Notes: <li>This service is not available in developer sandbox environment and will be made availablefor testing in your dedicated environment. ","operationId":"deleteApiKey","parameters":[{"description":"key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":"OK"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y807 : Resource not found Y806 : Invalid input"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete API Key","tags":["Auth"]}},"/auth/token":{"delete":{"deprecated":false,"description":"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: <li>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. ","operationId":"deleteToken","responses":{"204":{"content":{},"description":"No Content"},"401":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y020 : Invalid token in authorization header Y023 : Token has expired Y016 : Api-Version header missing Y015 : Unauthorized User Y027 : Unsupported authentication type Y007 : Authorization header missing Y020 : Invalid token in authorization header"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Token","tags":["Auth"]},"post":{"deprecated":false,"description":"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:<li>The content type has to be passed as application/x-www-form-urlencoded.<li>Upgrading to client credential authentication requires infrastructure reconfiguration. <li>Customers wishing to switch from another authentication scheme to client credential authentication, please contact Yodlee Client Services.</li>","operationId":"generateAccessToken","responses":{"201":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ClientCredentialTokenResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for loginName Y806 : Invalid input Y801 : Invalid length for loginName Y303 : clientId or secret is missing Y301 : Invalid clientId or secret Y305 : Access token can be issued only for pre-registered users Y004 : Inactive user Y901 : Service not supported "},"401":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y016 : loginName header missing Y015 : Unauthorized User Y016 : Api-Version header missing Y020 : Invalid token in authorization header Y027 : Unsupported authentication type"},"404":{"content":{},"description":"Not Found"}},"summary":"Generate Access Token","tags":["Auth"]}},"/cobrand/config/notifications/events":{"get":{"deprecated":true,"description":"Refer GET /configs/notifications/events. The get events service provides the list of events for which consumers subscribed to receive notifications. ","operationId":"getSubscribedEvents","parameters":[{"allowEmptyValue":false,"description":"eventName","in":"query","name":"eventName","schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CobrandNotificationResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Subscribed Events","tags":["Cobrand"]}},"/cobrand/config/notifications/events/{eventName}":{"delete":{"deprecated":true,"description":"Refer DELETE /configs/notifications/events/{eventName}. The delete events service is used to unsubscribe from an events service. ","operationId":"deleteSubscribedEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Subscription","tags":["Cobrand"]},"post":{"deprecated":true,"description":"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. ","operationId":"createSubscriptionEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCobrandNotificationEventRequest"}}},"description":"eventRequest","required":true},"responses":{"201":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required Y803 : callbackUrl required Y800 : Invalid value for callbackUrl"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Subscribe Event","tags":["Cobrand"]},"put":{"deprecated":true,"description":"Refer PUT /configs/notifications/events/{eventName}. The update events service is used to update the callback URL. If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown. Note: The content type has to be passed as application/json for the body parameter. ","operationId":"updateSubscribedEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCobrandNotificationEventRequest"}}},"description":"eventRequest","required":true},"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required Y803 : callbackUrl required Y800 : Invalid value for callbackUrl"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update Subscription","tags":["Cobrand"]}},"/cobrand/login":{"post":{"deprecated":false,"description":"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. ","operationId":"cobrandLogin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CobrandLoginRequest"}}},"description":"cobrandLoginRequest","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CobrandLoginResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for cobrandParam"},"401":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y003 : Account is locked, contact Yodlee customer care Y001 : User name and password required"},"404":{"content":{},"description":"Not Found"}},"summary":"Cobrand Login","tags":["Cobrand"]}},"/cobrand/logout":{"post":{"deprecated":false,"description":"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. ","operationId":"cobrandLogout","responses":{"204":{"content":{},"description":"Logout successful"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Cobrand Logout","tags":["Cobrand"]}},"/cobrand/publicKey":{"get":{"deprecated":true,"description":"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. ","operationId":"getPublicKey","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CobrandPublicKeyResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Public Key","tags":["Cobrand"]}},"/configs/notifications/events":{"get":{"deprecated":false,"description":"The get events service provides the list of events for which consumers subscribed to receive notifications. ","operationId":"getSubscribedNotificationEvents","parameters":[{"allowEmptyValue":false,"description":"eventName","in":"query","name":"eventName","schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ConfigsNotificationResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Subscribed Notification Events","tags":["Configs"]}},"/configs/notifications/events/{eventName}":{"delete":{"deprecated":false,"description":"The delete events service is used to unsubscribe from an events service. ","operationId":"deleteSubscribedNotificationEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Notification Subscription","tags":["Configs"]},"post":{"deprecated":false,"description":"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:<li>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.<li>The content type has to be passed as application/json for the body parameter.</li>","operationId":"createSubscriptionNotificationEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigsNotificationEventRequest"}}},"description":"eventRequest","required":true},"responses":{"201":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required Y803 : callbackUrl required Y800 : Invalid value for callbackUrl"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Subscribe For Notification Event","tags":["Configs"]},"put":{"deprecated":false,"description":"The update events service is used to update the callback URL. If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown. Note: <li>The content type has to be passed as application/json for the body parameter. ","operationId":"updateSubscribedNotificationEvent","parameters":[{"description":"eventName","in":"path","name":"eventName","required":true,"schema":{"enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigsNotificationEventRequest"}}},"description":"eventRequest","required":true},"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y803 : eventName required Y803 : callbackUrl required Y800 : Invalid value for callbackUrl"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update Notification Subscription","tags":["Configs"]}},"/configs/publicKey":{"get":{"deprecated":false,"description":"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:<li> The key in the response is a string in PEM format.</li><li>This endpoint is not available in the Sandbox environment and it is useful only if the PKI feature is enabled.</li>","operationId":"getPublicEncryptionKey","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ConfigsPublicKeyResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Public Key","tags":["Configs"]}},"/dataExtracts/events":{"get":{"deprecated":false,"description":"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 <a href=\"https://developer.yodlee.com/docs/api/1.1/DataExtracts\">dataExtracts</a> 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. ","operationId":"getDataExtractsEvents","parameters":[{"allowEmptyValue":false,"description":"Event Name","in":"query","name":"eventName","required":true,"schema":{"type":"string"}},{"allowEmptyValue":false,"description":"From DateTime (YYYY-MM-DDThh:mm:ssZ)","in":"query","name":"fromDate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":false,"description":"To DateTime (YYYY-MM-DDThh:mm:ssZ)","in":"query","name":"toDate","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DataExtractsEventResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for fromDate.fromDate cannot be greater than current time Y800 : Invalid value for toDate.toDate cannot be greater than current time Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days Y800 : Invalid value for fromDate.fromDate cannot be greater than toDate."},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Events","tags":["DataExtracts"]}},"/dataExtracts/userData":{"get":{"deprecated":false,"description":"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 <a href=\"https://developer.yodlee.com/docs/api/1.1/DataExtracts\">dataExtracts</a> page for more information. Note:<li>This service supports the localization feature and accepts locale as a header parameter.</li>","operationId":"getDataExtractsUserData","parameters":[{"allowEmptyValue":false,"description":"From DateTime (YYYY-MM-DDThh:mm:ssZ)","in":"query","name":"fromDate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Login Name","in":"query","name":"loginName","required":true,"schema":{"type":"string"}},{"allowEmptyValue":false,"description":"To DateTime (YYYY-MM-DDThh:mm:ssZ)","in":"query","name":"toDate","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DataExtractsUserDataResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for eventName Y821 : Data update event not supported Y800 : Invalid value for fromDate.fromDate cannot be greater than current time Y800 : Invalid value for toDate.toDate cannot be greater than current time .Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days Y800 : Invalid value for fromDate.fromDate can not be greater than toDate Y800 : Invalid value for loginName"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get userData","tags":["DataExtracts"]}},"/derived/holdingSummary":{"get":{"deprecated":false,"description":"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. ","operationId":"getHoldingSummary","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountIds","in":"query","name":"accountIds","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"e.g. Country, Sector, etc.","in":"query","name":"classificationType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"details","in":"query","name":"include","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DerivedHoldingSummaryResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for classificationType Y814 : Exchange rate not available for currency Y824 : The maximum number of accountIds permitted is 100 "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Holding Summary","tags":["Derived"]}},"/derived/networth":{"get":{"deprecated":false,"description":"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. ","operationId":"getNetworth","parameters":[{"allowEmptyValue":false,"description":"comma separated accountIds","in":"query","name":"accountIds","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities","in":"query","name":"container","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"from date for balance retrieval (YYYY-MM-DD)","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"details","in":"query","name":"include","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"D-daily, W-weekly or M-monthly","in":"query","name":"interval","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"skip (Min 0)","in":"query","name":"skip","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":false,"description":"toDate for balance retrieval (YYYY-MM-DD)","in":"query","name":"toDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"top (Max 500)","in":"query","name":"top","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DerivedNetworthResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountIds Y800 : Invalid value for fromDate Y800 : Invalid value for toDate Y809 : Invalid date range Y800 : Invalid value for interval Y802 : Future date not allowed Y814 : Exchange rate not available for currency Y800 : Invalid value for container"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Networth Summary","tags":["Derived"]}},"/derived/transactionSummary":{"get":{"deprecated":false,"description":"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:<ol> <li> Details can be requested for only one system-defined category<li>Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE<li>Dates will not be respected for monthly, yearly, and weekly details<li>When monthly details are requested, only the fromDate and toDate month will be respected<li>When yearly details are requested, only the fromDate and toDate year will be respected<li>For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate<li>This service supports the localization feature and accepts locale as a header parameter</li></ol>","operationId":"getTransactionSummary","parameters":[{"allowEmptyValue":false,"description":"comma separated account Ids","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"comma separated categoryIds","in":"query","name":"categoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION","in":"query","name":"categoryType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"YYYY-MM-DD format","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY","in":"query","name":"groupBy","required":true,"schema":{"type":"string"}},{"allowEmptyValue":false,"description":"details","in":"query","name":"include","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"TRUE/FALSE","in":"query","name":"includeUserCategory","schema":{"type":"boolean"}},{"allowEmptyValue":false,"description":"D-daily, W-weekly, M-mothly or Y-yearly","in":"query","name":"interval","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"YYYY-MM-DD format","in":"query","name":"toDate","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DerivedTransactionSummaryResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y010 : Invalid session Y800 : Invalid value for accountId Y800 : Invalid value for groupBy Y803 : groupBy required Y803 : categoryType required Y800 : Invalid value for categoryId Y800 : Invalid value for fromDate Y800 : Invalid value for toDate Y800 : Invalid value for fromDate or toDate Y814 : Exchange rate not available for currency Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE Y816 : User-defined category details can only be requested for one system categoryId with groupBy='CATEGORY' Y824 : The maximum number of accountIds permitted is 100 Y824 : The maximum number of categoryIds permitted is 100 Y824 : The maximum number of categoryTypes permitted is 100"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transaction Summary","tags":["Derived"]}},"/documents":{"get":{"deprecated":false,"description":"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. ","operationId":"getDocuments","parameters":[{"allowEmptyValue":false,"description":"The string used to search a document by its name.","in":"query","name":"Keyword","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"The unique identifier of an account. Retrieve documents for a given accountId.","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Accepts only one of the following valid document types: STMT, TAX, and EBILL.","in":"query","name":"docType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"The date from which documents have to be retrieved.","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"The date to which documents have to be retrieved.","in":"query","name":"toDate","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId Y800 : Invalid value for fromDate Y800 : Invalid value for toDate Y800 : Invalid value for docType"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Documents","tags":["Documents"]}},"/documents/{documentId}":{"delete":{"deprecated":false,"description":"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. ","operationId":"deleteDocument","parameters":[{"description":"documentId","in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for documentId Y868 : No action is allowed, as the data is being migrated to the Open Banking provider "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Document","tags":["Documents"]},"get":{"deprecated":false,"description":"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. ","operationId":"downloadDocument","parameters":[{"description":"documentId","in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentDownloadResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for documentId"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Download a Document","tags":["Documents"]}},"/holdings":{"get":{"deprecated":false,"description":"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. ","operationId":"getHoldings","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountId","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"e.g. Country, Sector, etc.","in":"query","name":"assetClassification.classificationType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"e.g. US","in":"query","name":"classificationValue","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"assetClassification","in":"query","name":"include","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"providerAccountId","in":"query","name":"p