{"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 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.","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:
  • 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.
    • ","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:
  • A real estate account addition is only supported for SYSTEM and MANUAL valuation type.
    • ","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:
  • Yodlee recommends to use this service before adding the real estate account to avoid failures.
    • ","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:
  • fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.
    • ","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:
  • A real estate account update is only supported for SYSTEM and MANUAL valuation type.
  • Attribute isEbillEnrolled is deprecated as it is applicable for bill accounts only.
    • ","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:
    1. cobsession
    2. JWT token
    Notes:
  • 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:
    1. cobsession
    2. JWT 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.
    • ","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:
    1. cobsession
    2. JWT token
    Notes:
  • 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:
  • 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:
  • 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.
    • ","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:
  • 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":"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:
  • 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:
  • 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.
    • ","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 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.
    ","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 dataExtracts page for more information.

    Note:
  • This service supports the localization feature and accepts locale as a header parameter.
    • ","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:
    1. Details can be requested for only one system-defined category
    2. Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE
    3. Dates will not be respected for monthly, yearly, and weekly details
    4. When monthly details are requested, only the fromDate and toDate month will be respected
    5. When yearly details are requested, only the fromDate and toDate year will be respected
    6. For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate
    7. This service supports the localization feature and accepts locale as a header parameter
    ","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":"providerAccountId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/HoldingResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId
    Y800 : Invalid value for providerAccountId
    Y800 : Invalid value for include
    Y800 : Invalid value for classificationType
    Y800 : Invalid value for classificationValue
    Y800 : Invalid value for include
    Y400 : classificationType mismatch
    Y400 : classificationValue mismatch
    Y824 : The maximum number of accountIds permitted is 100"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Holdings","tags":["Holdings"]}},"/holdings/assetClassificationList":{"get":{"deprecated":false,"description":"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.
    ","operationId":"getAssetClassificationList","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/HoldingAssetClassificationListResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Asset Classification List","tags":["Holdings"]}},"/holdings/holdingTypeList":{"get":{"deprecated":false,"description":"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
    ","operationId":"getHoldingTypeList","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/HoldingTypeListResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Holding Type List","tags":["Holdings"]}},"/holdings/securities":{"get":{"deprecated":false,"description":"The get security details service is used to get all the security information for the holdings
    ","operationId":"getSecurities","parameters":[{"allowEmptyValue":false,"description":"Comma separated holdingId","in":"query","name":"holdingId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/HoldingSecuritiesResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for holdingId
    Y824 : The maximum number of holdingIds permitted is 100"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Security Details","tags":["Holdings"]}},"/providerAccounts":{"get":{"deprecated":false,"description":"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.
    ","operationId":"getAllProviderAccounts","parameters":[{"description":"include","in":"query","name":"include","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated providerIds.","in":"query","name":"providerIds","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProviderAccountResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Provider Accounts","tags":["ProviderAccounts"]},"put":{"deprecated":false,"description":"The update account API is used to:

    -----------------------------------------------------------------------------------------------------------------------------------------

    Update All Eligible Accounts - Notes:
    ","operationId":"editCredentialsOrRefreshProviderAccount","parameters":[{"allowEmptyValue":false,"description":"comma separated providerAccountIds","in":"query","name":"providerAccountIds","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountRequest"}}},"description":"loginForm or field entity","required":false},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UpdatedProviderAccountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y805 : Multiple providerAccountId not supported for updating credentials
    Y800 : Invalid value for credentialsParam
    Y400 : id and value in credentialsParam are mandatory
    Y806 : Invalid input
    Y823 : Credentials are not applicable for real estate aggregated / manual accounts
    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":"Update Account","tags":["ProviderAccounts"]}},"/providerAccounts/profile":{"get":{"deprecated":false,"description":"The get provider accounts profile service is used to return the user profile details that are associated to the provider account.
    ","operationId":"getProviderAccountProfiles","parameters":[{"allowEmptyValue":false,"description":"Comma separated providerAccountIds.","in":"query","name":"providerAccountId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProviderAccountUserProfileResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get User Profile Details","tags":["ProviderAccounts"]}},"/providerAccounts/{providerAccountId}":{"delete":{"deprecated":false,"description":"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).
    ","operationId":"deleteProviderAccount","parameters":[{"description":"providerAccountId","in":"path","name":"providerAccountId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for providerAccountId
    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 Provider Account","tags":["ProviderAccounts"]},"get":{"deprecated":false,"description":"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.
    • ","operationId":"getProviderAccount","parameters":[{"allowEmptyValue":false,"description":"include credentials,questions","in":"query","name":"include","schema":{"type":"string"}},{"description":"providerAccountId","in":"path","name":"providerAccountId","required":true,"schema":{"format":"int64","type":"integer"}},{"allowEmptyValue":false,"description":"The unique identifier for the request that returns contextual data","in":"query","name":"requestId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetailResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for providerAccountId
    Y816 : questions can only be requested for questionAndAnswer Supported Sites"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Provider Account Details","tags":["ProviderAccounts"]}},"/providerAccounts/{providerAccountId}/preferences":{"put":{"deprecated":false,"description":"This endpoint is used to update preferences like data extracts and auto refreshes without triggering refresh for the providerAccount.
    Setting isDataExtractsEnabled to false will not trigger data extracts notification and dataExtracts/events will not reflect any data change that is happening for the providerAccount.
    Modified data will not be provided in the dataExtracts/userData endpoint.
    Setting isAutoRefreshEnabled to false will not trigger auto refreshes for the provider account.
    ","operationId":"updatePreferences","parameters":[{"description":"providerAccountId","in":"path","name":"providerAccountId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountPreferencesRequest"}}},"description":"preferences","required":true},"responses":{"204":{"content":{},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for preferences
    Y800 : Invalid value for preferences.isDataExtractsEnabled
    Y800 : Invalid value for preferences.isAutoRefreshEnabled
    Y807 : Resource not found
    Y830 : Data extracts feature has to be enabled to set preferences.isDataExtractsEnabled as true
    Y830 : Auto refresh feature has to be enabled to set preferences.isAutoRefreshEnabled as true
    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":"Update Preferences","tags":["ProviderAccounts"]}},"/providers":{"get":{"deprecated":false,"description":"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 customer

    Only 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_DATA
    BASIC_AGG_DATA OR ACCT_PROFILE
    BASIC_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=paymentAccountNumber
    dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber
    dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumber

    The 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:
    1. In a product flow involving user interaction, Yodlee recommends invoking this service with filters.
    2. Without filters, the service may perform slowly as it takes a few minutes to return data in the response.
    3. The AuthParameter appears in the response only in case of token-based aggregation sites.
    4. 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.
    5. This service supports the localization feature and accepts locale as a header parameter.
    6. The capability has been deprecated in query parameter and response.
    ","operationId":"getAllProviders","parameters":[{"allowEmptyValue":false,"description":"CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated","in":"query","name":"capability","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.","in":"query","name":"dataset$filter","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.","in":"query","name":"fullAccountNumberFields","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Institution Id for Single site selection","in":"query","name":"institutionId","schema":{"format":"int64","type":"integer"}},{"allowEmptyValue":false,"description":"Name in minimum 1 character or routing number.","in":"query","name":"name","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Search priority","in":"query","name":"priority","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Max 5 Comma seperated Provider Ids","in":"query","name":"providerId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"skip (Min 0) - This is not applicable along with 'name' parameter.","in":"query","name":"skip","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":false,"description":"top (Max 500) - This is not applicable along with 'name' parameter.","in":"query","name":"top","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProviderResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for priority
    Y800 : Invalid value for providerName
    Y801 : Invalid length for a site search. The search string must have atleast 1 character
    Y800 : Invalid value for skip
    Y804 : Permitted values of top between 1 - 500
    Y821 : Dataset not supported
    Y820 : The additionalDataSet is not supported for Get provider API"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Providers","tags":["Providers"]}},"/providers/count":{"get":{"deprecated":false,"description":"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 endpoint

    Note:
  • The capability has been deprecated in the query parameter.
    • ","operationId":"getProvidersCount","parameters":[{"allowEmptyValue":false,"description":"CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated","in":"query","name":"capability","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.","in":"query","name":"dataset$filter","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.","in":"query","name":"fullAccountNumberFields","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Name in minimum 1 character or routing number.","in":"query","name":"name","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Search priority","in":"query","name":"priority","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProvidersCountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for priority
    Y800 : Invalid value for providerName
    Y801 : Invalid length for a site search. The search string must have at least 1 character
    Y800 : Invalid value for skip
    Y804 : Permitted values of top between 1 - 500
    Y821 : Dataset not supported
    Y820 : The additionalDataSet is not supported for Get provider API"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Providers Count","tags":["Providers"]}},"/providers/{providerId}":{"get":{"deprecated":false,"description":"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.","operationId":"getProvider","parameters":[{"description":"providerId","in":"path","name":"providerId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ProviderDetailResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for providerId"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Provider Details","tags":["Providers"]}},"/statements":{"get":{"deprecated":false,"description":"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.
    ","operationId":"getStatements","parameters":[{"allowEmptyValue":false,"description":"accountId","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"creditCard/loan/insurance","in":"query","name":"container","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"from date for statement retrieval (YYYY-MM-DD)","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"isLatest (true/false)","in":"query","name":"isLatest","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"ACTIVE,TO_BE_CLOSED,CLOSED","in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StatementResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for accountId
    Y800 : Invalid value for status
    Y805 : Multiple containers not supported
    Y800 : Invalid value for container
    Y800 : Invalid value for isLatest
    Y800 : Invalid value for fromDate
    "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Statements","tags":["Statements"]}},"/transactions":{"get":{"deprecated":false,"description":"The Transaction service is used to get a list of transactions for a user.
    By default, this service returns the last 30 days of transactions from today's date.
    The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.
    Values for categoryId parameter can be fetched from get transaction category list service.
    The categoryId is used to filter transactions based on system-defined category as well as user-defined category.
    User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002
    The 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.
    Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys \"R\" Us.
    sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

    Note
  • TDE is made available for bank and card accounts and for the US market only.The address field in the response is available only when the TDE key is turned on.
  • The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 transactions.
  • This service supports the localization feature and accepts locale as a header parameter.
    ","operationId":"getTransactions","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountIds","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"DEBIT/CREDIT","in":"query","name":"baseType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated categoryIds","in":"query","name":"categoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)","in":"query","name":"categoryType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"bank/creditCard/investment/insurance/loan","in":"query","name":"container","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated detailCategoryIds","in":"query","name":"detailCategoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction from date(YYYY-MM-DD)","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated highLevelCategoryIds","in":"query","name":"highLevelCategoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction search text","in":"query","name":"keyword","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"skip (Min 0)","in":"query","name":"skip","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":false,"description":"Transaction end date (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"}},{"allowEmptyValue":false,"description":"Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment","in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for baseType
    Y800 : Invalid value for fromDate
    Y800 : Invalid value for category
    Y800 : Invalid value for toDate
    Y800 : Invalid value for container
    Y809 : Invalid date range
    Y804 : Permitted values of top between 1 - 500
    Y805 : Multiple containers not supported
    Y800 : Invalid value for transaction type
    Y824 : The maximum number of accountIds permitted is 100
    Y824 : The maximum number of categoryIds permitted is 100
    Y824 : The maximum number of highLevelCategoryIds permitted is 100
    Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled
    Y823 : detailCategoryId is not for applicable containers other than bank and card
    Y824 : The maximum number of detailCategoryIds permitted is 100
    Y800 : Invalid value for detailCategoryId"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transactions","tags":["Transactions"]}},"/transactions/categories":{"get":{"deprecated":false,"description":"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.
    • ","operationId":"getTransactionCategories","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TransactionCategoryResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transaction Category List","tags":["Transactions"]},"post":{"deprecated":false,"description":"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).
    ","operationId":"createTransactionCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCategoryRequest"}}},"description":"User Transaction Category in JSON format","required":true},"responses":{"201":{"content":{},"description":"Created Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for categoryParam
    Y800 : Invalid value for source
    Y801 : Invalid length for categoryName. Min 1 and max 50 is required
    Y803 : parentCategoryId required
    Y811 : categoryName value already exists"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Create Category","tags":["Transactions"]},"put":{"deprecated":false,"description":"The update transaction categories service is used to update the transaction category name
    for a high level category, a system-defined category and a user-defined category.
    The renamed category can be set back to the original name by passing an empty string for categoryName.
    The categoryName can accept minimum of 1, maximum of 50 alphanumeric or special characters.
    The HTTP response code is 204 (Success without content).
    ","operationId":"updateTransactionCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCategoryRequest"}}},"description":"updateCategoryRequest","required":true},"responses":{"204":{"content":{},"description":"Updated Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for categoryParam
    Y800 : Invalid value for source
    Y801 : Invalid length for categoryName. Min 1 and max 50 is required
    Y803 : id required
    Y811 : categoryName value already exists"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update Category","tags":["Transactions"]}},"/transactions/categories/rules":{"get":{"deprecated":true,"description":"The get transaction categorization rule service is used to get all the categorization rules.
    ","operationId":"getTransactionCategorizationRulesDeprecated","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"items":{"$ref":"#/components/schemas/TransactionCategorizationRule"},"type":"array"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transaction Categorization Rules","tags":["Transactions"]},"post":{"deprecated":false,"description":"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 allowed
    The HTTP response code is 201 (Created Successfully).","operationId":"createOrRunTransactionCategorizationRules","parameters":[{"allowEmptyValue":false,"description":"To run rules, pass action=run. Only value run is supported","in":"query","name":"action","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"rules(JSON format) to categorize the transactions","in":"query","name":"ruleParam","schema":{"type":"string"}}],"responses":{"201":{"content":{},"description":"Created Successfully"},"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y806 : Invalid input
    Y400 : Rule already exists. Rule should be unique in terms of combination of description and amount"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Create or Run Transaction Categorization Rule","tags":["Transactions"]}},"/transactions/categories/rules/{ruleId}":{"delete":{"deprecated":false,"description":"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).
    ","operationId":"deleteTransactionCategorizationRule","parameters":[{"description":"ruleId","in":"path","name":"ruleId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"content":{},"description":"Deleted Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for ruleId"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Transaction Categorization Rule","tags":["Transactions"]},"post":{"deprecated":false,"description":"The run transaction categorization rule service is used to run a rule on transactions, to categorize the transactions.
    The HTTP response code is 204 (Success with no content).
    ","operationId":"runTransactionCategorizationRule","parameters":[{"in":"query","name":"action","required":true,"schema":{"default":"run","enum":["run"],"type":"string"}},{"description":"Unique id of the categorization rule","in":"path","name":"ruleId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"content":{},"description":"Run Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for ruleId
    Y400 : Categorization already in progress"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Run Transaction Categorization Rule","tags":["Transactions"]},"put":{"deprecated":false,"description":"The update transaction categorization rule service is used to update a categorization rule for both system-defined category as well as user-defined category.
    ruleParam JSON input should be as explained in the create transaction categorization rule service.
    The HTTP response code is 204 (Success without content).
    ","operationId":"updateTransactionCategorizationRule","parameters":[{"description":"ruleId","in":"path","name":"ruleId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCategorizationRuleRequest"}}},"description":"transactionCategoriesRuleRequest","required":true},"responses":{"204":{"content":{},"description":"Updated Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for ruleId
    Y806 : Invalid input"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update Transaction Categorization Rule","tags":["Transactions"]}},"/transactions/categories/txnRules":{"get":{"deprecated":false,"description":"The get transaction categorization rule service is used to get all the categorization rules.
    ","operationId":"getTransactionCategorizationRules","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TransactionCategorizationRuleResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transaction Categorization Rules","tags":["Transactions"]}},"/transactions/categories/{categoryId}":{"delete":{"deprecated":false,"description":"The delete transaction categories service is used to delete the given user-defined category.
    The HTTP response code is 204 (Success without content).
    ","operationId":"deleteTransactionCategory","parameters":[{"description":"categoryId","in":"path","name":"categoryId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"content":{},"description":"Deleted Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for categoryId"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete Category","tags":["Transactions"]}},"/transactions/count":{"get":{"deprecated":false,"description":"The count service provides the total number of transactions for a specific user depending on the input parameters passed.
    If you are implementing pagination for transactions, call this endpoint before calling GET /transactions to know the number of transactions that are returned for the input parameters passed.
    The functionality of the input parameters remains the same as that of the GET /transactions endpoint.
    ","operationId":"getTransactionsCount","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountIds\t","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"DEBIT/CREDIT","in":"query","name":"baseType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated categoryIds","in":"query","name":"categoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)","in":"query","name":"categoryType","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"bank/creditCard/investment/insurance/loan","in":"query","name":"container","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated detailCategoryIds","in":"query","name":"detailCategoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction from date(YYYY-MM-DD)","in":"query","name":"fromDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated highLevelCategoryIds","in":"query","name":"highLevelCategoryId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction search text\t","in":"query","name":"keyword","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction end date (YYYY-MM-DD)","in":"query","name":"toDate","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Transaction Type(SELL,SWEEP, etc.)","in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TransactionCountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for detailCategoryId
    Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled
    Y823 : detailCategoryId is not applicable for containers other than bank and card
    Y824 : The maximum number of detailCategoryIds permitted is 100
    "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Transactions Count","tags":["Transactions"]}},"/transactions/{transactionId}":{"put":{"deprecated":false,"description":"The update transaction service is used to update the category,consumer description, memo for a transaction.
    The HTTP response code is 204 (Success without content).
    ","operationId":"updateTransaction","parameters":[{"description":"transactionId","in":"path","name":"transactionId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRequest"}}},"description":"transactionRequest","required":true},"responses":{"204":{"content":{},"description":"Updated Successfully"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y812 : Required field -container missing in the transactionParam parameter input
    Y800 : Invalid value for transactionId
    Y800 : Invalid value for categoryId
    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":"Update Transaction","tags":["Transactions"]}},"/user":{"get":{"deprecated":false,"description":"The get user details service is used to get the user profile information and the application preferences set at the time of user registration.
    ","operationId":"getUser","responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UserDetailResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get User Details","tags":["User"]},"put":{"deprecated":false,"description":"The update user details service is used to update user details like name, address, currency preference, etc.
    Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.
    The HTTP response code is 204 (Success without content).
    ","operationId":"updateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}},"description":"userRequest","required":true},"responses":{"204":{"content":{},"description":"No Content"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Update User Details","tags":["User"]}},"/user/accessTokens":{"get":{"deprecated":false,"description":"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.
    ","operationId":"getAccessTokens","parameters":[{"description":"appIds","in":"query","name":"appIds","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UserAccessTokensResponse"}}},"description":"OK"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Access Tokens","tags":["User"]}},"/user/logout":{"post":{"deprecated":false,"description":"Deprecated: This endpoint is deprecated for API Key-based authentication. The user logout service allows the user to log out of the application.
    The service does not return a response body. The HTTP response code is 204 (Success with no content).
    ","operationId":"userLogout","responses":{"204":{"content":{},"description":"Logout successful"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"User Logout","tags":["User"]}},"/user/register":{"post":{"deprecated":false,"description":"The register user service is used to register a user in Yodlee.
    The loginName cannot include spaces and must be between 3 and 150 characters.
    locale passed must be one of the supported locales for the customer.
    Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.
    userParam is accepted as a body parameter.

    Note:
  • The content type has to be passed as application/json for the body parameter.
    • ","operationId":"registerUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"description":"userRequest","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UserResponse"}}},"description":"Login Successful"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for loginName
    Y800 : Invalid value for email
    Y801 : Invalid length for loginName
    "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Register User","tags":["User"]}},"/user/samlLogin":{"post":{"deprecated":false,"description":"The SAML login service is used to authenticate system users with a SAML response.
    A new user will be created with the input provided if that user isn't already in the system.
    For existing users, the system will make updates based on changes or new information.
    When authentication is successful, a user session token is returned.

    Note:
  • The content type has to be passed as application/x-www-form-urlencoded.
  • issuer, source and samlResponse should be passed as body parameters.
    • ","operationId":"samlLogin","parameters":[{"description":"issuer","in":"query","name":"issuer","required":true,"schema":{"type":"string"}},{"description":"samlResponse","in":"query","name":"samlResponse","required":true,"schema":{"type":"string"}},{"description":"source","in":"query","name":"source","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UserResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y013 : Invalid value for samlResponse
    Y013 : Invalid value for issuer"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Saml Login","tags":["User"]}},"/user/unregister":{"delete":{"deprecated":false,"description":"The delete user service is used to delete or unregister a user from Yodlee.
    Once deleted, the information related to the users cannot be retrieved.
    The HTTP response code is 204 (Success without content)
    ","operationId":"unregister","responses":{"204":{"content":{},"description":"No Content"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Delete User","tags":["User"]}},"/verification":{"get":{"deprecated":false,"description":"The get verification status service is used to retrieve the verification status of all accounts for which the MS or CDV process has been initiated.
    For the MS process, the account details object returns the aggregated information of the verified accounts. For the CDV process, the account details object returns the user provided account information.
    ","operationId":"getVerificationStatus","parameters":[{"allowEmptyValue":false,"description":"Comma separated accountId","in":"query","name":"accountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"Comma separated providerAccountId","in":"query","name":"providerAccountId","schema":{"type":"string"}},{"allowEmptyValue":false,"description":"verificationType","in":"query","name":"verificationType","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/VerificationStatusResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y901 : Service not supported
    Y813 : Either of accountId or providerAccountId should be provided
    Y800 : Invalid value for accountId
    Y800 : Invalid value for verification.verificationType
    Y800 : Invalid value for providerAccountId
    Y835 : Account(s) not eligible for Matching verification
    Y836 : No verification initiated"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Get Verification Status","tags":["Verification"]},"post":{"deprecated":false,"description":"The post verification service is used to initiate the matching service (MS) and the challenge deposit account verification (CDV) process to verify account ownership.
    The MS and CDV process can verify ownership of only bank accounts (i.e., checking and savings).
    The MS verification can be initiated only for an already aggregated account or a providerAccount.
    The prerequisite for the MS verification process is to request the ACCT_PROFILE dataset with the HOLDER_NAME attribute.
    In the MS verification process, a string-match of the account holder name with the registered user name is performed instantaneously. You can contact the Yodlee CustomerCare to configure the full name or only the last name match.
    Once the CDV process is initiated Yodlee will post the microtransaction (i.e., credit and debit) in the user's account. The CDV process takes 2 to 3 days to complete as it requires the user to provide the microtransaction details.
    The CDV process is currently supported only in the United States.
    The verificationId in the response can be used to track the verification request.

    Notes:
  • This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.","operationId":"initiateMatchingOrChallengeDepositeVerification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequest"}}},"description":"verification information","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/VerificationResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y901 : Service not supported
    Y812 : Required field/value - verification.verificationType missing in the verificationParam
    Y812 : Required field/value - accountNumber missing in the verificationParam
    Y812 : Required field/value - accountType missing in the verificationParam
    Y812 : Required field/value - bankTransferCode missing in the verificationParam
    Y812 : Required field/value - bankTransferCode.id missing in the verificationParam
    Y812 : Required field/value - bankTransferCode.type missing in the verificationParam
    Y800 : Invalid value for verification.verificationType
    Y800 : Invalid value for verificationParam
    Y800 : Invalid value for bankTransferCode.type
    Y800 : Invalid value for bankTransferCode.id
    Y800 : Invalid value for accountType
    Y800 : Invalid value for accountId
    Y813 : Account details should be provided
    Y801 : Invalid length for accountNumber
    Y835 : Account(s) not eligible for Challenge Deposit verification
    Y806 : Invalid Input
    Y840 : Verification has been initiated already
    Y837 : Account has been verified already"},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Initiaite Matching Service and Challenge Deposit","tags":["Verification"]},"put":{"deprecated":false,"description":"The put verification service is used to complete the challenge deposit verification (CDV) process.
    This service is used only by the customer of CDV flow.
    In the CDV process, the user-provided microtransaction details (i.e., credit and debit) is matched against the microtransactions posted by Yodlee. For a successful verification of the account's ownership both the microtransaction details should match.
    The CDV process is currently supported only in the United States.

    Notes:
    • This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.
    ","operationId":"verifyChallengeDeposit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVerificationRequest"}}},"description":"verification information","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/VerificationResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y901 : Service not supported
    Y812 : Required field/value - verification.verificationType missing in the verificationParam
    Y812 : Required field/value - amount.amount missing in the verificationParam
    Y812 : Required field/value - baseType missing in the verificationParam
    Y812 : Required field/value - currency missing in the verificationParam
    Y812 : Required field/value - providerAccountId missing in the verificationParam
    Y812 : Required field/value - accountId missing in the verificationParam
    Y800 : Invalid value for verificationParam
    Y800 : Invalid value for verification.verificationType
    Y800 : Invalid value for baseType
    Y800 : Invalid value for providerAccountId
    Y800 : Invalid value for accountId
    Y813 : Transaction should be provided
    Y801 : Invalid length for accountNumber
    Y801 : Invalid length for amount
    Y835 : Account(s) not eligible for Challenge Deposit verification
    Y806 : Invalid Input
    Y840 : Verification has been initiated already
    Y837 : Account has been verified already
    Y838 : The currency code provided does not match with the currency of the transaction executed on the target account
    Y846 : The number of financial transactions made on the target account does not match with the number of transactions entered by the user.
    Y842 : Number of retries exceeded the maximum Challenge Deposit verification limit
    Y844 : Financial Instructions were not executed successfully on the target account
    Y845 : Verification time expired. Please try initiating challenge deposit again
    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":"Verify Challenge Deposit","tags":["Verification"]}},"/verifyAccount/{providerAccountId}":{"post":{"deprecated":false,"description":"The verify account service is used to verify the account's ownership by matching the transaction details with the accounts aggregated for the user.
    • If a match is identified, the service returns details of all the accounts along with the matched transaction's details.
    • If no transaction match is found, an empty response will be returned.
    • A maximum of 5 transactionCriteria can be passed in a request.
    • The baseType, date, and amount parameters should mandatorily be passed.
    • The optional dateVariance parameter cannot be more than 7 days. For example, +7, -4, or +/-2.
    • Pass the container or accountId parameters for better performance.
    • This service supports the localization feature and accepts locale as a header parameter.
    ","operationId":"initiateAccountVerification","parameters":[{"description":"providerAccountId","in":"path","name":"providerAccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyAccountRequest"}}},"description":"verificationParam","required":true},"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/VerifyAccountResponse"}}},"description":"OK"},"400":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/YodleeError"}}},"description":"Y800 : Invalid value for container
    Y800 : Invalid value for accountId
    Y800 : Invalid value for amount
    Y800 : Invalid value for dateVariance
    Y801 : Invalid length for keyword
    Y804 : Permitted values of dateVariance between 1 - 7
    Y806 : Invalid input
    Y807 : Resource not found
    Y809 : Invalid date range
    Y812 : Required field/value - transactionCriteria missing in the input
    Y812 : Required field/value - amount missing in the transactionCriteria
    Y812 : Required field/value - amount date in the transactionCriteria
    Y812 : Required field/value - baseType missing in the transactionCriteria
    Y823 : Transaction not applicable for container
    Y824 : The maximum number of transactionCriteria permitted is 5
    Y857 : Transactions are not refreshed in the past 24 hours
    Y858 : Only active accounts can be verified
    Y901 : Service not supported
    "},"401":{"content":{},"description":"Unauthorized"},"404":{"content":{},"description":"Not Found"}},"summary":"Verify Accounts Using Transactions","tags":["Verify Account"]}}},"components":{"schemas":{"AccessTokens":{"properties":{"appId":{"description":"The identifier of the application for which the access token is generated.

    Endpoints:
    • GET user/accessTokens
    ","type":"string"},"url":{"description":"Base URL using which the application is accessed.

    Endpoints:
    • GET user/accessTokens
    ","type":"string"},"value":{"description":"Access token value used to invoke the widgets/apps.

    Endpoints:
    • GET user/accessTokens
    ","type":"string"}},"title":"AccessTokens","type":"object"},"Account":{"properties":{"401kLoan":{"$ref":"#/components/schemas/Money"},"CONTAINER":{"description":"The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"readOnly":true,"type":"string"},"accountName":{"description":"The account name as it appears at the site.
    (The POST accounts service response return this field as name)
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"accountNumber":{"description":"The account number as it appears on the site. (The POST accounts service response return this field as number)
    Additional Details: Bank/ Loan/ Insurance/ Investment:
    The account number for the bank account as it appears at the site.
    Credit Card: The account number of the card account as it appears at the site,
    i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST accounts
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"accountStatus":{"description":"The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus
    Additional Details:
    ACTIVE: All the added manual and aggregated accounts status will be made \"ACTIVE\" by default.
    TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED
    INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services
    CLOSED: Users can update the status as CLOSED, if the account is closed with the provider.

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


    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"address":{"$ref":"#/components/schemas/AccountAddress"},"aggregationSource":{"description":"The source through which the account(s) are added in the system.
    Valid Values: SYSTEM, USER
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"amountDue":{"$ref":"#/components/schemas/Money"},"annualPercentageYield":{"description":"Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account.
    Applicable containers: bank
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"annuityBalance":{"$ref":"#/components/schemas/Money"},"apr":{"description":"The annual percentage rate (APR) is the yearly rate of interest on the credit card account.
    Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance.
    Aggregated / Manual: Aggregated
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"associatedProviderAccountId":{"description":"The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time.
    Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts.

    Aggregated / Manual: Aggregated
    Applicable containers: All Containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"autoRefresh":{"$ref":"#/components/schemas/AutoRefresh"},"availableBalance":{"$ref":"#/components/schemas/Money"},"availableCash":{"$ref":"#/components/schemas/Money"},"availableCredit":{"$ref":"#/components/schemas/Money"},"balance":{"$ref":"#/components/schemas/Money"},"bankTransferCode":{"description":"Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/BankTransferCode"},"readOnly":true,"type":"array"},"cash":{"$ref":"#/components/schemas/Money"},"cashApr":{"description":"Annual percentage rate applied to cash withdrawals on the card.

    Account Type: Aggregated
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","type":"number"},"cashValue":{"$ref":"#/components/schemas/Money"},"classification":{"description":"The classification of the account such as personal, corporate, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, reward, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["OTHER","PERSONAL","CORPORATE","SMALL_BUSINESS","TRUST","ADD_ON_CARD","VIRTUAL_CARD"],"readOnly":true,"type":"string"},"collateral":{"description":"Property or possession offered to support a loan that can be seized on a default.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"coverage":{"description":"The coverage-related details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/Coverage"},"readOnly":true,"type":"array"},"createdDate":{"description":"The date on which the account is created in the Yodlee system.
    Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"currentBalance":{"$ref":"#/components/schemas/Money"},"currentLevel":{"description":"Current level of the reward program the user is associated with. E.g. Silver, Jade etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"deathBenefit":{"$ref":"#/components/schemas/Money"},"derivedApr":{"description":"Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase.
    Aggregated / Manual / Derived: Derived
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"displayedName":{"description":"The name or identification of the account owner, as it appears at the FI site.
    Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.

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

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"enrollmentDate":{"description":"Date on which the user is enrolled on the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"escrowBalance":{"$ref":"#/components/schemas/Money"},"estimatedDate":{"description":"The date on which the home value was estimated.

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

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"faceAmount":{"$ref":"#/components/schemas/Money"},"frequency":{"description":"The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account.

    Aggregated / Manual: Both
    Applicable containers: creditCard, insurance, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["DAILY","ONE_TIME","WEEKLY","EVERY_2_WEEKS","SEMI_MONTHLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","EVERY_2_MONTHS","EBILL","FIRST_DAY_MONTHLY","LAST_DAY_MONTHLY","EVERY_4_WEEKS","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"fullAccountNumber":{"description":"Full account number of the account that is included only when include = fullAccountNumber is provided in the request. For student loan account the account number that will be used for ACH or fund transfer

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, loan, reward, otherAssets, otherLiabilities
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
      • Note : fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.
    ","readOnly":true,"type":"string"},"fullAccountNumberList":{"$ref":"#/components/schemas/FullAccountNumberList"},"guarantor":{"description":"A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"holder":{"description":"Holder details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/AccountHolder"},"readOnly":true,"type":"array"},"homeInsuranceType":{"description":"Type of home insurance, like -
    • HOME_OWNER
    • RENTAL
    • RENTER
    • etc..
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["HOME_OWNER","RENTAL","RENTER","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"homeValue":{"$ref":"#/components/schemas/Money"},"id":{"description":"The primary key of the account resource and the unique identifier for the account.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET investmentOptions
    • GET accounts/historicalBalances
    • POST accounts
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"includeInNetWorth":{"description":"Used to determine whether an account to be considered in the networth calculation.

    Aggregated / Manual: Aggregated
    Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"interestPaidLastYear":{"$ref":"#/components/schemas/Money"},"interestPaidYTD":{"$ref":"#/components/schemas/Money"},"interestRate":{"description":"
    Bank: The interest rate offered by a FI to its depositors on a bank account.
    Loan: Interest rate applied on the loan.
    Additional Details:
    Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"interestRateType":{"description":"The type of the interest rate, for example, fixed or variable.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["FIXED","VARIABLE","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"isAsset":{"description":"The account to be considered as an asset or liability.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"isManual":{"description":"Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user.
    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastEmployeeContributionAmount":{"$ref":"#/components/schemas/Money"},"lastEmployeeContributionDate":{"description":"The date on which the last employee contribution was made to the 401k account.
    Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type.

    Aggregated / Manual: Aggregated
    Applicable containers: investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lastPayment":{"$ref":"#/components/schemas/Money"},"lastPaymentAmount":{"$ref":"#/components/schemas/Money"},"lastPaymentDate":{"description":"The date on which the payment for the previous or current billing cycle is done.
    Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date time the account information was last retrieved from the provider site and updated in the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lender":{"description":"The financial institution that provides the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lifeInsuranceType":{"description":"Type of life insurance.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["OTHER","TERM_LIFE_INSURANCE","UNIVERSAL_LIFE_INSURANCE","WHOLE_LIFE_INSURANCE","VARIABLE_LIFE_INSURANCE","ULIP","ENDOWMENT"],"readOnly":true,"type":"string"},"loanPayByDate":{"description":"The date by which the payoff amount should be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"loanPayoffAmount":{"$ref":"#/components/schemas/Money"},"loanPayoffDetails":{"$ref":"#/components/schemas/LoanPayoffDetails"},"marginBalance":{"$ref":"#/components/schemas/Money"},"maturityAmount":{"$ref":"#/components/schemas/Money"},"maturityDate":{"description":"The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid.
    Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"memo":{"description":"The additional description or notes given by the user.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"minimumAmountDue":{"$ref":"#/components/schemas/Money"},"moneyMarketBalance":{"$ref":"#/components/schemas/Money"},"nextLevel":{"description":"The eligible next level of the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"nickname":{"description":"The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"oauthMigrationStatus":{"description":"Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"originalLoanAmount":{"$ref":"#/components/schemas/Money"},"originationDate":{"description":"The date on which the loan is disbursed.

    Aggregated / Manual: Both
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"overDraftLimit":{"$ref":"#/components/schemas/Money"},"paymentProfile":{"$ref":"#/components/schemas/PaymentProfile"},"policyEffectiveDate":{"description":"The date on which the insurance policy coverage commences.
    Applicable containers: insurance
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyFromDate":{"description":"The date the insurance policy began.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyStatus":{"description":"The status of the policy.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["ACTIVE","INACTIVE","OTHER"],"readOnly":true,"type":"string"},"policyTerm":{"description":"The duration for which the policy is valid or in effect. For example, one year, five years, etc.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyToDate":{"description":"The date to which the policy exists.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"premium":{"$ref":"#/components/schemas/Money"},"premiumPaymentTerm":{"description":"The number of years for which premium payments have to be made in a policy.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"primaryRewardUnit":{"description":"Primary reward unit for this reward program. E.g. miles, points, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"principalBalance":{"$ref":"#/components/schemas/Money"},"profile":{"$ref":"#/components/schemas/AccountProfile"},"providerAccountId":{"description":"The primary key of the provider account resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"providerId":{"description":"Identifier of the provider site. The primary key of provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"providerName":{"description":"Service provider or institution name where the account originates. This belongs to the provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"recurringPayment":{"$ref":"#/components/schemas/Money"},"remainingBalance":{"$ref":"#/components/schemas/Money"},"repaymentPlanType":{"description":"The type of repayment plan that the borrower prefers to repay the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values:
    ","enum":["STANDARD","GRADUATED","EXTENDED","INCOME_BASED","INCOME_CONTINGENT","INCOME_SENSITIVE","PAY_AS_YOU_EARN","REVISED_PAY_AS_YOU_EARN"],"readOnly":true,"type":"string"},"rewardBalance":{"description":"Information of different reward balances associated with the account.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/RewardBalance"},"readOnly":true,"type":"array"},"runningBalance":{"$ref":"#/components/schemas/Money"},"shortBalance":{"$ref":"#/components/schemas/Money"},"sourceAccountStatus":{"description":"Indicates the status of the loan account.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values:
    ","enum":["IN_REPAYMENT","DEFAULTED","IN_SCHOOL","IN_GRACE_PERIOD","DELINQUENCY","DEFERMENT","FORBEARANCE"],"readOnly":true,"type":"string"},"sourceId":{"description":"A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts.

    Applicable containers: bank, creditCard, investment, insurance, loan, reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"term":{"description":"The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid.
    Additional Details:
    Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"totalCashLimit":{"$ref":"#/components/schemas/Money"},"totalCreditLimit":{"$ref":"#/components/schemas/Money"},"totalCreditLine":{"$ref":"#/components/schemas/Money"},"totalUnvestedBalance":{"$ref":"#/components/schemas/Money"},"totalVestedBalance":{"$ref":"#/components/schemas/Money"},"userClassification":{"description":"Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST accounts
  • GET dataExtracts/userData
    • Applicable Values
    ","enum":["BUSINESS","PERSONAL"],"readOnly":true,"type":"string"},"valuationType":{"description":"The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","MANUAL"],"readOnly":true,"type":"string"}},"title":"Account","type":"object"},"AccountAddress":{"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"sourceType":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"type":{"enum":["HOME","BUSINESS","POBOX","RETAIL","OFFICE","SMALL_BUSINESS","COMMUNICATION","PERMANENT","STATEMENT_ADDRESS","PAYMENT","PAYOFF","UNKNOWN"],"type":"string"},"zip":{"type":"string"}},"title":"AccountAddress","type":"object"},"AccountDataset":{"properties":{"additionalStatus":{"description":"The status of last update attempted for the dataset.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    Applicable Values
    ","enum":["LOGIN_IN_PROGRESS","DATA_RETRIEVAL_IN_PROGRESS","ACCT_SUMMARY_RECEIVED","AVAILABLE_DATA_RETRIEVED","PARTIAL_DATA_RETRIEVED","DATA_RETRIEVAL_FAILED","DATA_NOT_AVAILABLE","ACCOUNT_LOCKED","ADDL_AUTHENTICATION_REQUIRED","BETA_SITE_DEV_IN_PROGRESS","CREDENTIALS_UPDATE_NEEDED","INCORRECT_CREDENTIALS","PROPERTY_VALUE_NOT_AVAILABLE","INVALID_ADDL_INFO_PROVIDED","REQUEST_TIME_OUT","SITE_BLOCKING_ERROR","UNEXPECTED_SITE_ERROR","SITE_NOT_SUPPORTED","SITE_UNAVAILABLE","TECH_ERROR","USER_ACTION_NEEDED_AT_SITE","SITE_SESSION_INVALIDATED","NEW_AUTHENTICATION_REQUIRED","DATASET_NOT_SUPPORTED","ENROLLMENT_REQUIRED_FOR_DATASET","CONSENT_REQUIRED","CONSENT_EXPIRED","CONSENT_REVOKED","INCORRECT_OAUTH_TOKEN","MIGRATION_IN_PROGRESS"],"readOnly":true,"type":"string"},"lastUpdateAttempt":{"description":"Indicate when the last attempt was performed to update the dataset for the given provider account

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"Indicate when the dataset is last updated successfully for the given provider account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"name":{"description":"The name of the dataset requested from the provider site

    Account Type: Manual
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["BASIC_AGG_DATA","ADVANCE_AGG_DATA","ACCT_PROFILE","DOCUMENT"],"type":"string"},"nextUpdateScheduled":{"description":"Indicates when the next attempt to update the dataset is scheduled.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"updateEligibility":{"description":"Indicate whether the dataset is eligible for update or not.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    Applicable Values
    ","enum":["ALLOW_UPDATE","ALLOW_UPDATE_WITH_CREDENTIALS","DISALLOW_UPDATE"],"readOnly":true,"type":"string"}},"title":"AccountDataset","type":"object"},"AccountHistoricalBalancesResponse":{"properties":{"account":{"items":{"$ref":"#/components/schemas/AccountHistory"},"readOnly":true,"type":"array"}},"title":"AccountHistoricalBalancesResponse","type":"object"},"AccountHistory":{"properties":{"historicalBalances":{"items":{"$ref":"#/components/schemas/HistoricalBalance"},"readOnly":true,"type":"array"},"id":{"format":"int64","readOnly":true,"type":"integer"}},"title":"AccountHistory","type":"object"},"AccountHolder":{"properties":{"gender":{"description":"Identifiers of the account holder.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"identifier":{"description":"Identifiers of the account holder.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/Identifier"},"readOnly":true,"type":"array"},"name":{"$ref":"#/components/schemas/Name"},"ownership":{"description":"Indicates the ownership of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values
    ","enum":["PRIMARY","SECONDARY","CUSTODIAN","OTHERS","POWER_OF_ATTORNEY","TRUSTEE","JOINT_OWNER","BENEFICIARY","AAS","BUSINESS","DBA","TRUST"],"readOnly":true,"type":"string"}},"title":"AccountHolder","type":"object"},"AccountProfile":{"properties":{"address":{"description":"Address available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/AccountAddress"},"readOnly":true,"type":"array"},"email":{"description":"Email Id available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/Email"},"readOnly":true,"type":"array"},"identifier":{"description":"Identifiers available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/Identifier"},"readOnly":true,"type":"array"},"phoneNumber":{"description":"Phone number available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/PhoneNumber"},"readOnly":true,"type":"array"}},"title":"AccountProfile","type":"object"},"AccountResponse":{"properties":{"account":{"items":{"$ref":"#/components/schemas/Account"},"readOnly":true,"type":"array"}},"title":"AccountResponse","type":"object"},"ApiKeyOutput":{"properties":{"createdDate":{"description":"The date on which the apiKey was created for the customer.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","type":"string"},"expiresIn":{"description":"Time in seconds after which the JWT token created for users expires.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","format":"int64","type":"integer"},"key":{"description":"ApiKey or the issuer key used to generate the JWT token for authentication.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","type":"string"},"publicKey":{"description":"Public key uploaded by the customer while generating ApiKey.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"ApiKeyOutput","type":"object"},"ApiKeyRequest":{"properties":{"publicKey":{"description":"Public key uploaded by the customer while generating ApiKey.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"ApiKeyRequest","type":"object"},"ApiKeyResponse":{"properties":{"apiKey":{"description":"ApiKey customer details.

    Endpoints:
    • GET /auth/apiKey
    • POST /auth/apiKey
    ","items":{"$ref":"#/components/schemas/ApiKeyOutput"},"type":"array"}},"title":"ApiKeyResponse","type":"object"},"AssetClassification":{"properties":{"allocation":{"description":"The allocation percentage of the holding.

    Required Feature Enablement: Asset classification feature

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"classificationType":{"description":"The type of classification to which the investment belongs (assetClass, country, sector, and style).
    Required Feature Enablement: Asset classification feature

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"classificationValue":{"description":"The value for each classificationType.
    Required Feature Enablement: Asset classification feature

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"AssetClassification","type":"object"},"AssetClassificationList":{"properties":{"classificationType":{"description":"The type of classification to which the investment belongs (assetClass, country, sector, and style).
    Required Feature Enablement: Asset classification feature

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"classificationValue":{"description":"The value for each classificationType.
    Required Feature Enablement: Asset classification feature

    Applicable containers: investment
    ","items":{"type":"string"},"readOnly":true,"type":"array"}},"title":"AssetClassificationList","type":"object"},"Attribute":{"properties":{"container":{"description":"Containers for which the attributes are supported.

    Endpoints:
    • GET providers
    • GET providers/{providerId}
    ","items":{"enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"type":"string"},"type":"array"},"containerAttributes":{"$ref":"#/components/schemas/ContainerAttributes"},"fromDate":{"description":"Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.

    Endpoints:
    • POST providerAccounts
    • PUT providerAccounts
    ","readOnly":true,"type":"string"},"fromFinYear":{"description":"Applicable only to TAX attribute of DOCUMENT dataset.

    Endpoints:
    • POST providerAccounts
    • PUT providerAccounts
    ","readOnly":true,"type":"string"},"name":{"description":"Attributes that are supported for a dataset.

    Endpoints:
    • GET providers
    • GET providers/{providerId}
    ","enum":["BASIC_ACCOUNT_INFO","TRANSACTIONS","STATEMENTS","HOLDINGS","ACCOUNT_DETAILS","TAX","EBILLS","FULL_ACCT_NUMBER","BANK_TRANSFER_CODE","HOLDER_NAME","HOLDER_DETAILS","PAYMENT_PROFILE","PAYMENT_DETAILS","INTEREST_DETAILS","COVERAGE"],"type":"string"},"toDate":{"description":"Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.

    Endpoints:
    • POST providerAccounts
    • PUT providerAccounts
    ","readOnly":true,"type":"string"},"toFinYear":{"description":"Applicable only to TAX attribute of DOCUMENT dataset.

    Endpoints:
    • POST providerAccounts
    • PUT providerAccounts
    ","readOnly":true,"type":"string"}},"title":"Attribute","type":"object"},"AutoRefresh":{"properties":{"additionalStatus":{"description":"Indicates the reason for the status.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values
    ","enum":["SCHEDULED","TEMP_ERROR","SITE_BLOCKING","SITE_NOT_SUPPORTED","REAL_TIME_MFA_REQUIRED","USER_ACTION_REQUIRED","UNSUBSCRIBED","MANUAL_ACCOUNT"],"readOnly":true,"type":"string"},"asOfDate":{"description":"Date on which the auto refresh status is determined.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"status":{"description":"Indicates whether auto refresh is enabled or disabled.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values
    ","enum":["ENABLED","DISABLED"],"readOnly":true,"type":"string"}},"title":"AutoRefresh","type":"object"},"BankTransferCode":{"properties":{"id":{"description":"The FI's branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom).
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST verification
    ","type":"string"},"type":{"description":"The bank transfer code type varies depending on the region of the account origination.
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST verification
    Applicable Values
    ","enum":["BSB","IFSC","ROUTING_NUMBER","SORT_CODE"],"type":"string"}},"title":"BankTransferCode","type":"object"},"Capability":{"properties":{"container":{"items":{"enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"type":"string"},"readOnly":true,"type":"array"},"name":{"readOnly":true,"type":"string"}},"title":"Capability","type":"object"},"ClientCredentialToken":{"properties":{"accessToken":{"description":"Access Token to access YSL 1.1 services.

    Endpoints:
    • POST /auth/token
    ","readOnly":true,"type":"string"},"expiresIn":{"description":"Time in seconds after which the issued accessToken expires.

    Endpoints:
    • POST /auth/token
    ","format":"int32","readOnly":true,"type":"integer"},"issuedAt":{"description":"The date and time on which accessToken was created for the customer.

    Endpoints:
    • POST /auth/token
    ","readOnly":true,"type":"string"}},"title":"ClientCredentialToken","type":"object"},"ClientCredentialTokenResponse":{"properties":{"token":{"$ref":"#/components/schemas/ClientCredentialToken"}},"title":"ClientCredentialTokenResponse","type":"object"},"Cobrand":{"properties":{"cobrandLogin":{"maxLength":2147483647,"minLength":1,"type":"string"},"cobrandPassword":{"maxLength":2147483647,"minLength":1,"type":"string"},"locale":{"description":"The customer's locale that will be considered for the localization functionality.

    Endpoints:
    • POST cobrand/login
    ","pattern":"[a-z]{2}_[A-Z]{2}","type":"string"}},"required":["cobrandLogin","cobrandPassword"],"title":"Cobrand","type":"object"},"CobrandLoginRequest":{"properties":{"cobrand":{"$ref":"#/components/schemas/Cobrand"}},"required":["cobrand"],"title":"CobrandLoginRequest","type":"object"},"CobrandLoginResponse":{"properties":{"applicationId":{"description":"The application identifier.

    Endpoints:
    • POST cobrand/login
    ","readOnly":true,"type":"string"},"cobrandId":{"description":"Unique identifier of the cobrand (customer) in the system.

    Endpoints:
    • POST cobrand/login
    ","format":"int64","readOnly":true,"type":"integer"},"locale":{"description":"The customer's locale that will be considered for the localization functionality.

    Endpoints:
    • POST cobrand/login
    ","readOnly":true,"type":"string"},"session":{"$ref":"#/components/schemas/CobrandSession"}},"title":"CobrandLoginResponse","type":"object"},"CobrandNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET cobrand/config/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"},"name":{"description":"Name of the event for which the customers must subscribe to receive notifications.
    Valid Value: Notification Events Name

    Endpoints:
    • GET cobrand/config/notifications/events
    Applicable Values
    ","enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}},"title":"CobrandNotificationEvent","type":"object"},"CobrandNotificationResponse":{"properties":{"event":{"items":{"$ref":"#/components/schemas/CobrandNotificationEvent"},"readOnly":true,"type":"array"}},"title":"CobrandNotificationResponse","type":"object"},"CobrandPublicKeyResponse":{"properties":{"keyAlias":{"description":"The key name used for encryption.

    Endpoints:
    • GET cobrand/publicKey
    ","readOnly":true,"type":"string"},"keyAsPemString":{"description":"Public key that the customer should be using to encrypt the credentials and answers before sending to the add & update providerAccounts APIs.

    Endpoints:
    • GET cobrand/publicKey
    ","readOnly":true,"type":"string"}},"title":"CobrandPublicKeyResponse","type":"object"},"CobrandSession":{"properties":{"cobSession":{"type":"string"}},"title":"CobrandSession","type":"object"},"ConfigsNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET configs/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"},"name":{"description":"Name of the event for which the customers must subscribe to receive notifications.
    Valid Value: Notification Events Name

    Endpoints:
    • GET configs/notifications/events
    Applicable Values
    ","enum":["REFRESH","DATA_UPDATES","AUTO_REFRESH_UPDATES"],"type":"string"}},"title":"ConfigsNotificationEvent","type":"object"},"ConfigsNotificationResponse":{"properties":{"event":{"items":{"$ref":"#/components/schemas/ConfigsNotificationEvent"},"readOnly":true,"type":"array"}},"title":"ConfigsNotificationResponse","type":"object"},"ConfigsPublicKey":{"properties":{"alias":{"description":"The key name used for encryption.

    Endpoints:
    • GET configs/publicKey
    ","readOnly":true,"type":"string"},"key":{"description":"Public key that the customer should be using to encrypt the credentials and answers before sending to the add and update providerAccounts APIs.

    Endpoints:
    • GET configs/publicKey
    ","readOnly":true,"type":"string"}},"title":"ConfigsPublicKey","type":"object"},"ConfigsPublicKeyResponse":{"properties":{"publicKey":{"$ref":"#/components/schemas/ConfigsPublicKey"}},"title":"ConfigsPublicKeyResponse","type":"object"},"Contact":{"properties":{"email":{"description":"Email Id of the merchant

    Applicable containers: bank,creditCard,investment,loan
    ","type":"string"},"phone":{"description":"Phone number of the merchant

    Applicable containers: bank,creditCard,investment,loan
    ","type":"string"}},"title":"Contact","type":"object"},"ContainerAttributes":{"properties":{"BANK":{"$ref":"#/components/schemas/TransactionDays"},"CREDITCARD":{"$ref":"#/components/schemas/TransactionDays"},"INSURANCE":{"$ref":"#/components/schemas/TransactionDays"},"INVESTMENT":{"$ref":"#/components/schemas/TransactionDays"},"LOAN":{"$ref":"#/components/schemas/TransactionDays"}},"title":"ContainerAttributes","type":"object"},"Coordinates":{"properties":{"latitude":{"description":"Latitude of the merchant

    Applicable containers: bank,creditCard,loan
    ","format":"double","type":"number"},"longitude":{"description":"Longitude of the merchant

    Applicable containers: bank,creditCard,loan
    ","format":"double","type":"number"}},"title":"Coordinates","type":"object"},"Coverage":{"properties":{"amount":{"description":"The coverage amount-related details.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/CoverageAmount"},"readOnly":true,"type":"array"},"endDate":{"description":"The date on which the coverage for the account ends or expires.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"planType":{"description":"The plan type for an insurance provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values:
    ","enum":["PPO","HMO","UNKNOWN"],"readOnly":true,"type":"string"},"startDate":{"description":"The date on which the coverage for the account starts.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"type":{"description":"The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values:
    ","enum":["VISION","DENTAL","MEDICAL","HEALTH","DEATH_COVER","TOTAL_PERMANENT_DISABILITY","ACCIDENTAL_DEATH_COVER","INCOME_PROTECTION","DEATH_TOTAL_PERMANENT_DISABILITY","OTHER"],"readOnly":true,"type":"string"}},"title":"Coverage","type":"object"},"CoverageAmount":{"properties":{"cover":{"$ref":"#/components/schemas/Money"},"limitType":{"description":"The type of coverage limit indicates if the coverage is in-network or out-of-network.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values:
    ","enum":["IN_NETWORK","OUT_NETWORK"],"readOnly":true,"type":"string"},"met":{"$ref":"#/components/schemas/Money"},"type":{"description":"The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values:
    ","enum":["DEDUCTIBLE","OUT_OF_POCKET","ANNUAL_BENEFIT","MAX_BENEFIT","COVERAGE_AMOUNT","MONTHLY_BENEFIT","OTHER"],"readOnly":true,"type":"string"},"unitType":{"description":"The type of coverage unit indicates if the coverage is for an individual or a family.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    Applicable Values:
    ","enum":["PER_FAMILY","PER_MEMBER"],"readOnly":true,"type":"string"}},"title":"CoverageAmount","type":"object"},"CreateAccountInfo":{"properties":{"accountName":{"maxLength":100,"minLength":1,"type":"string"},"accountNumber":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9]+$","type":"string"},"accountType":{"maxLength":2147483647,"minLength":1,"type":"string"},"address":{"$ref":"#/components/schemas/AccountAddress"},"amountDue":{"$ref":"#/components/schemas/Money"},"balance":{"$ref":"#/components/schemas/Money"},"dueDate":{"type":"string"},"frequency":{"enum":["DAILY","ONE_TIME","WEEKLY","EVERY_2_WEEKS","SEMI_MONTHLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","EVERY_2_MONTHS","EBILL","FIRST_DAY_MONTHLY","LAST_DAY_MONTHLY","EVERY_4_WEEKS","UNKNOWN","OTHER"],"type":"string"},"homeValue":{"$ref":"#/components/schemas/Money"},"includeInNetWorth":{"type":"string"},"memo":{"maxLength":250,"minLength":0,"type":"string"},"nickname":{"maxLength":50,"minLength":0,"type":"string"},"valuationType":{"enum":["SYSTEM","MANUAL"],"type":"string"}},"required":["accountName","accountType"],"title":"CreateAccountInfo","type":"object"},"CreateAccountRequest":{"properties":{"account":{"$ref":"#/components/schemas/CreateAccountInfo"}},"required":["account"],"title":"CreateAccountRequest","type":"object"},"CreateCobrandNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET cobrand/config/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"CreateCobrandNotificationEvent","type":"object"},"CreateCobrandNotificationEventRequest":{"properties":{"event":{"$ref":"#/components/schemas/CreateCobrandNotificationEvent"}},"required":["event"],"title":"CreateCobrandNotificationEventRequest","type":"object"},"CreateConfigsNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET configs/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"CreateConfigsNotificationEvent","type":"object"},"CreateConfigsNotificationEventRequest":{"properties":{"event":{"$ref":"#/components/schemas/CreateConfigsNotificationEvent"}},"required":["event"],"title":"CreateConfigsNotificationEventRequest","type":"object"},"CreatedAccountInfo":{"properties":{"accountName":{"readOnly":true,"type":"string"},"accountNumber":{"readOnly":true,"type":"string"},"id":{"format":"int64","readOnly":true,"type":"integer"}},"title":"CreatedAccountInfo","type":"object"},"CreatedAccountResponse":{"properties":{"account":{"items":{"$ref":"#/components/schemas/CreatedAccountInfo"},"readOnly":true,"type":"array"}},"title":"CreatedAccountResponse","type":"object"},"DataExtractsAccount":{"properties":{"401kLoan":{"$ref":"#/components/schemas/Money"},"CONTAINER":{"description":"The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"readOnly":true,"type":"string"},"accountName":{"description":"The account name as it appears at the site.
    (The POST accounts service response return this field as name)
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"accountNumber":{"description":"The account number as it appears on the site. (The POST accounts service response return this field as number)
    Additional Details: Bank/ Loan/ Insurance/ Investment:
    The account number for the bank account as it appears at the site.
    Credit Card: The account number of the card account as it appears at the site,
    i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST accounts
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"accountStatus":{"description":"The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus
    Additional Details:
    ACTIVE: All the added manual and aggregated accounts status will be made \"ACTIVE\" by default.
    TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED
    INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services
    CLOSED: Users can update the status as CLOSED, if the account is closed with the provider.

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


    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"address":{"$ref":"#/components/schemas/AccountAddress"},"aggregationSource":{"description":"The source through which the account(s) are added in the system.
    Valid Values: SYSTEM, USER
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"amountDue":{"$ref":"#/components/schemas/Money"},"annualPercentageYield":{"description":"Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account.
    Applicable containers: bank
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"annuityBalance":{"$ref":"#/components/schemas/Money"},"apr":{"description":"The annual percentage rate (APR) is the yearly rate of interest on the credit card account.
    Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance.
    Aggregated / Manual: Aggregated
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"associatedProviderAccountId":{"description":"The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time.
    Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts.

    Aggregated / Manual: Aggregated
    Applicable containers: All Containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"availableBalance":{"$ref":"#/components/schemas/Money"},"availableCash":{"$ref":"#/components/schemas/Money"},"availableCredit":{"$ref":"#/components/schemas/Money"},"balance":{"$ref":"#/components/schemas/Money"},"bankTransferCode":{"description":"Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/BankTransferCode"},"readOnly":true,"type":"array"},"cash":{"$ref":"#/components/schemas/Money"},"cashApr":{"description":"Annual percentage rate applied to cash withdrawals on the card.

    Account Type: Aggregated
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","type":"number"},"cashValue":{"$ref":"#/components/schemas/Money"},"classification":{"description":"The classification of the account such as personal, corporate, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, reward, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["OTHER","PERSONAL","CORPORATE","SMALL_BUSINESS","TRUST","ADD_ON_CARD","VIRTUAL_CARD"],"readOnly":true,"type":"string"},"collateral":{"description":"Property or possession offered to support a loan that can be seized on a default.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"coverage":{"description":"The coverage-related details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/Coverage"},"readOnly":true,"type":"array"},"createdDate":{"description":"The date on which the account is created in the Yodlee system.
    Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"currentBalance":{"$ref":"#/components/schemas/Money"},"currentLevel":{"description":"Current level of the reward program the user is associated with. E.g. Silver, Jade etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"deathBenefit":{"$ref":"#/components/schemas/Money"},"derivedApr":{"description":"Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase.
    Aggregated / Manual / Derived: Derived
    Applicable containers: creditCard
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"displayedName":{"description":"The name or identification of the account owner, as it appears at the FI site.
    Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.

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

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"enrollmentDate":{"description":"Date on which the user is enrolled on the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"escrowBalance":{"$ref":"#/components/schemas/Money"},"estimatedDate":{"description":"The date on which the home value was estimated.

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

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"faceAmount":{"$ref":"#/components/schemas/Money"},"frequency":{"description":"The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account.

    Aggregated / Manual: Both
    Applicable containers: creditCard, insurance, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["DAILY","ONE_TIME","WEEKLY","EVERY_2_WEEKS","SEMI_MONTHLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","EVERY_2_MONTHS","EBILL","FIRST_DAY_MONTHLY","LAST_DAY_MONTHLY","EVERY_4_WEEKS","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"guarantor":{"description":"A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"homeInsuranceType":{"description":"Type of home insurance, like -
    • HOME_OWNER
    • RENTAL
    • RENTER
    • etc..
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["HOME_OWNER","RENTAL","RENTER","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"homeValue":{"$ref":"#/components/schemas/Money"},"id":{"description":"The primary key of the account resource and the unique identifier for the account.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET investmentOptions
    • GET accounts/historicalBalances
    • POST accounts
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"includeInNetWorth":{"description":"Used to determine whether an account to be considered in the networth calculation.

    Aggregated / Manual: Aggregated
    Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"interestPaidLastYear":{"$ref":"#/components/schemas/Money"},"interestPaidYTD":{"$ref":"#/components/schemas/Money"},"interestRate":{"description":"
    Bank: The interest rate offered by a FI to its depositors on a bank account.
    Loan: Interest rate applied on the loan.
    Additional Details:
    Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"interestRateType":{"description":"The type of the interest rate, for example, fixed or variable.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["FIXED","VARIABLE","UNKNOWN","OTHER"],"readOnly":true,"type":"string"},"isAsset":{"description":"The account to be considered as an asset or liability.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"isDeleted":{"description":"Indicates if the account is marked as deleted.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"isManual":{"description":"Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user.
    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastEmployeeContributionAmount":{"$ref":"#/components/schemas/Money"},"lastEmployeeContributionDate":{"description":"The date on which the last employee contribution was made to the 401k account.
    Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type.

    Aggregated / Manual: Aggregated
    Applicable containers: investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lastPayment":{"$ref":"#/components/schemas/Money"},"lastPaymentAmount":{"$ref":"#/components/schemas/Money"},"lastPaymentDate":{"description":"The date on which the payment for the previous or current billing cycle is done.
    Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date time the account information was last retrieved from the provider site and updated in the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lender":{"description":"The financial institution that provides the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"lifeInsuranceType":{"description":"Type of life insurance.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["OTHER","TERM_LIFE_INSURANCE","UNIVERSAL_LIFE_INSURANCE","WHOLE_LIFE_INSURANCE","VARIABLE_LIFE_INSURANCE","ULIP","ENDOWMENT"],"readOnly":true,"type":"string"},"loanPayByDate":{"description":"The date by which the payoff amount should be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"loanPayoffAmount":{"$ref":"#/components/schemas/Money"},"loanPayoffDetails":{"$ref":"#/components/schemas/LoanPayoffDetails"},"marginBalance":{"$ref":"#/components/schemas/Money"},"maturityAmount":{"$ref":"#/components/schemas/Money"},"maturityDate":{"description":"The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid.
    Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"memo":{"description":"The additional description or notes given by the user.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"minimumAmountDue":{"$ref":"#/components/schemas/Money"},"moneyMarketBalance":{"$ref":"#/components/schemas/Money"},"nextLevel":{"description":"The eligible next level of the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"nickname":{"description":"The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"oauthMigrationStatus":{"description":"Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"originalLoanAmount":{"$ref":"#/components/schemas/Money"},"originationDate":{"description":"The date on which the loan is disbursed.

    Aggregated / Manual: Both
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"overDraftLimit":{"$ref":"#/components/schemas/Money"},"policyEffectiveDate":{"description":"The date on which the insurance policy coverage commences.
    Applicable containers: insurance
    Aggregated / Manual: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyFromDate":{"description":"The date the insurance policy began.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyStatus":{"description":"The status of the policy.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["ACTIVE","INACTIVE","OTHER"],"readOnly":true,"type":"string"},"policyTerm":{"description":"The duration for which the policy is valid or in effect. For example, one year, five years, etc.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"policyToDate":{"description":"The date to which the policy exists.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"premium":{"$ref":"#/components/schemas/Money"},"premiumPaymentTerm":{"description":"The number of years for which premium payments have to be made in a policy.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"primaryRewardUnit":{"description":"Primary reward unit for this reward program. E.g. miles, points, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"principalBalance":{"$ref":"#/components/schemas/Money"},"providerAccountId":{"description":"The primary key of the provider account resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"providerId":{"description":"Identifier of the provider site. The primary key of provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"providerName":{"description":"Service provider or institution name where the account originates. This belongs to the provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"recurringPayment":{"$ref":"#/components/schemas/Money"},"remainingBalance":{"$ref":"#/components/schemas/Money"},"repaymentPlanType":{"description":"The type of repayment plan that the borrower prefers to repay the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values:
    ","enum":["STANDARD","GRADUATED","EXTENDED","INCOME_BASED","INCOME_CONTINGENT","INCOME_SENSITIVE","PAY_AS_YOU_EARN","REVISED_PAY_AS_YOU_EARN"],"readOnly":true,"type":"string"},"rewardBalance":{"description":"Information of different reward balances associated with the account.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/RewardBalance"},"readOnly":true,"type":"array"},"runningBalance":{"$ref":"#/components/schemas/Money"},"shortBalance":{"$ref":"#/components/schemas/Money"},"sourceAccountStatus":{"description":"Indicates the status of the loan account.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values:
    ","enum":["IN_REPAYMENT","DEFAULTED","IN_SCHOOL","IN_GRACE_PERIOD","DELINQUENCY","DEFERMENT","FORBEARANCE"],"readOnly":true,"type":"string"},"sourceId":{"description":"A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts.

    Applicable containers: bank, creditCard, investment, insurance, loan, reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"term":{"description":"The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid.
    Additional Details:
    Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"totalCashLimit":{"$ref":"#/components/schemas/Money"},"totalCreditLimit":{"$ref":"#/components/schemas/Money"},"totalCreditLine":{"$ref":"#/components/schemas/Money"},"totalUnvestedBalance":{"$ref":"#/components/schemas/Money"},"totalVestedBalance":{"$ref":"#/components/schemas/Money"},"userClassification":{"description":"Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST accounts
  • GET dataExtracts/userData
    • Applicable Values
    ","enum":["BUSINESS","PERSONAL"],"readOnly":true,"type":"string"},"valuationType":{"description":"The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","MANUAL"],"readOnly":true,"type":"string"}},"title":"DataExtractsAccount","type":"object"},"DataExtractsEvent":{"properties":{"data":{"$ref":"#/components/schemas/DataExtractsEventData"},"info":{"readOnly":true,"type":"string"}},"title":"DataExtractsEvent","type":"object"},"DataExtractsEventData":{"properties":{"fromDate":{"readOnly":true,"type":"string"},"toDate":{"readOnly":true,"type":"string"},"userCount":{"format":"int32","readOnly":true,"type":"integer"},"userData":{"items":{"$ref":"#/components/schemas/DataExtractsEventUserData"},"readOnly":true,"type":"array"}},"title":"DataExtractsEventData","type":"object"},"DataExtractsEventLinks":{"properties":{"href":{"readOnly":true,"type":"string"},"methodType":{"readOnly":true,"type":"string"},"rel":{"readOnly":true,"type":"string"}},"title":"DataExtractsEventLinks","type":"object"},"DataExtractsEventResponse":{"properties":{"event":{"$ref":"#/components/schemas/DataExtractsEvent"}},"title":"DataExtractsEventResponse","type":"object"},"DataExtractsEventUserData":{"properties":{"links":{"items":{"$ref":"#/components/schemas/DataExtractsEventLinks"},"readOnly":true,"type":"array"},"user":{"$ref":"#/components/schemas/DataExtractsUser"}},"title":"DataExtractsEventUserData","type":"object"},"DataExtractsHolding":{"properties":{"accountId":{"description":"Unique identifier of the account to which the security is linked.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"accruedIncome":{"$ref":"#/components/schemas/Money"},"accruedInterest":{"$ref":"#/components/schemas/Money"},"contractQuantity":{"description":"The quantity of tradeable units in a contract.
    Note: The contract quantity field is only applicable to commodity and currency.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"costBasis":{"$ref":"#/components/schemas/Money"},"couponRate":{"description":"The stated interest rate for a bond.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"createdDate":{"description":"The date on which the holding is created in the Yodlee system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"cusipNumber":{"description":"The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"description":{"description":"The description (name) for the holding (E.g., Cisco Systems)
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"enrichedDescription":{"description":"The enrichedDescription is the security description of the normalized holding

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"exercisedQuantity":{"description":"The quantity of the employee stock options that are already exercised or bought by the employee.
    Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"expirationDate":{"description":"The date on which an option, right or warrant expires.
    Note: The expiration date field is only applicable to options and employee stock options.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"holdingType":{"description":"Type of holding

    Applicable containers: investment, insurance
    ","enum":["stock","mutualFund","bond","CD","option","moneyMarketFund","other","remic","future","commodity","currency","unitInvestmentTrust","employeeStockOption","insuranceAnnuity","unknown","preferredStock","ETF","warrants","ETN"],"readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the security added in the system. This is the primary key of the holding resource.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"interestRate":{"description":"The interest rate on a CD.
    Note: The interest rate field is only applicable to CD.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"isShort":{"description":"Indicates that the holding is a short trading.

    Applicable containers: investment
    ","readOnly":true,"type":"boolean"},"isin":{"description":"The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

    Note: The ISIN field is only applicable to the trade related transactions

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date when the information was last updated in the system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"matchStatus":{"description":"Indicates the security match status id of the investment option identified during security normalization.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"maturityDate":{"description":"The stated maturity date of a bond or CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"optionType":{"description":"The type of the option position (i.e., put or call).
    Note: The option type field is only applicable to options.

    Applicable containers: investment
    Applicable Values
    ","enum":["put","call","unknown","other"],"readOnly":true,"type":"string"},"price":{"$ref":"#/components/schemas/Money"},"providerAccountId":{"description":"Unique identifier for the user's association with the provider.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"quantity":{"description":"The quantity held for the holding.
    Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"securityStyle":{"description":"Indicates the security style of holding identified through the security service.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"securityType":{"description":"Indicates the security type of holding identified through the security service.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"spread":{"$ref":"#/components/schemas/Money"},"strikePrice":{"$ref":"#/components/schemas/Money"},"symbol":{"description":"The symbol of the security.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"term":{"description":"The fixed duration for which the bond or CD is issued.
    Note: The term field is only applicable to CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"unvestedQuantity":{"description":"Indicates the number of unvested quantity or units.
    Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"unvestedValue":{"$ref":"#/components/schemas/Money"},"value":{"$ref":"#/components/schemas/Money"},"vestedQuantity":{"description":"The quantity of units or shares that are already vested on a vest date.
    Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedSharesExercisable":{"description":"The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
    Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedValue":{"$ref":"#/components/schemas/Money"},"vestingDate":{"description":"The date on which a RSU, RSA, or an employee stock options become vested.
    Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"DataExtractsHolding","type":"object"},"DataExtractsProviderAccount":{"properties":{"aggregationSource":{"description":"The source through which the providerAccount is added in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"createdDate":{"description":"The date on when the provider account is created in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"id":{"description":"Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"isDeleted":{"description":"Indicates if the provider account is deleted from the system.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"isManual":{"description":"Indicates whether account is a manual or aggregated provider account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastUpdated":{"description":"Indicate when the providerAccount is last updated successfully.

    Account Type: Aggregated
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"oauthMigrationStatus":{"description":"Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET providerAccounts
    • GET providerAccounts/{providerAccountId}
    • PUT providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"providerId":{"description":"Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"requestId":{"description":"Unique id generated to indicate the request.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"status":{"description":"The status of last update attempted for the account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["LOGIN_IN_PROGRESS","USER_INPUT_REQUIRED","IN_PROGRESS","PARTIAL_SUCCESS","SUCCESS","FAILED","MIGRATION_IN_PROGRESS"],"readOnly":true,"type":"string"}},"title":"DataExtractsProviderAccount","type":"object"},"DataExtractsTransaction":{"properties":{"CONTAINER":{"description":"The account's container.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"readOnly":true,"type":"string"},"accountId":{"description":"The account from which the transaction was made. This is basically the primary key of the account resource.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"amount":{"$ref":"#/components/schemas/Money"},"baseType":{"description":"Indicates if the transaction appears as a debit or a credit transaction in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["CREDIT","DEBIT"],"readOnly":true,"type":"string"},"category":{"description":"The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"categoryId":{"description":"The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"categorySource":{"description":"Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"categoryType":{"description":"The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","enum":["TRANSFER","DEFERRED_COMPENSATION","UNCATEGORIZE","INCOME","EXPENSE"],"readOnly":true,"type":"string"},"checkNumber":{"description":"The checkNumber of the transaction.

    Applicable containers: bank
    ","readOnly":true,"type":"string"},"commission":{"$ref":"#/components/schemas/Money"},"createdDate":{"readOnly":true,"type":"string"},"cusipNumber":{"description":"The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.

    Note    : The CUSIP number field applies only to trade related transactions.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"date":{"description":"The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"description":{"$ref":"#/components/schemas/Description"},"detailCategoryId":{"description":"The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories.

    Applicable containers: bank,creditCard
    ","format":"int64","readOnly":true,"type":"integer"},"highLevelCategoryId":{"description":"The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"holdingDescription":{"description":"For transactions involving securities, this captures the securities description.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"id":{"description":"An unique identifier for the transaction. The combination of the id and account container are unique in the system.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"interest":{"$ref":"#/components/schemas/Money"},"isDeleted":{"description":"Indicates if the transaction is marked as deleted.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"isManual":{"description":"Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"boolean"},"isin":{"description":"International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"lastUpdated":{"readOnly":true,"type":"string"},"memo":{"description":"Additional notes provided by the user for a particular transaction through application or API services.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"merchant":{"$ref":"#/components/schemas/Merchant"},"parentCategoryId":{"description":"The parentCategoryId of the category assigned to the transaction.
    Note: This field will be provided in the response if the transaction is assigned to a user-created category.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"postDate":{"description":"The date on which the transaction is posted to the account.

    Applicable containers: bank,creditCard,insurance,loan
    ","readOnly":true,"type":"string"},"price":{"$ref":"#/components/schemas/Money"},"principal":{"$ref":"#/components/schemas/Money"},"quantity":{"description":"The quantity associated with the transaction.
    Note: The quantity field applies only to trade-related transactions.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"runningBalance":{"$ref":"#/components/schemas/Money"},"sedol":{"description":"SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"settleDate":{"description":"It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"sourceId":{"description":"A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.
    Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.","readOnly":true,"type":"string"},"sourceType":{"description":"The source through which the transaction is added to the Yodlee system.

    Applicable containers: bank,creditCard,investment,insurance,loann
    Applicable Values:
    ","enum":["AGGREGATED","MANUAL"],"readOnly":true,"type":"string"},"status":{"description":"The status of the transaction: pending or posted.
    Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["POSTED","PENDING","SCHEDULED","FAILED","CLEARED"],"readOnly":true,"type":"string"},"subType":{"description":"The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","enum":["AUTH_HOLD","AUTH_REQUEST","OVERDRAFT_CHARGE","CREDIT_ADJUSTMENT","PIN_DEBIT","BANK_DIRECT_DEPOSIT","DIVIDEND_DEPOSIT","INTEREST_SAVINGS","INTEREST_ADJUSTMENT","ONLINE_PURCHASE","PURCHASED_WITH_CHECK","RECURRING_BILLING","TAX_PAYMENT","PAYMENT_BY_CHECK","PAYMENT_PLAN","FEE_REFUND","WIRE_TRANSFER_CHARGE","ACCOUNT_TO_ACCOUNT_TRANSFER","BANK_TO_BANK_TRANSACTION","BANK_TO_NON_BANK_ACCOUNT_TRANSFER","CASH_WITHDRAWAL_AT_FI","ATM_CASH_WITHDRAWAL","AUTH_PROCESSING","AUTH_RELEASE","PRE_AUTH","AUTH_COMPLETE","AUTH_VOID","BALANCE_ENQUIRY","ACCOUNT_VERIFICATION","PRE_AUTH_COMPLETION","SERVICE_CHARGE","SERVICE_CHARGE_FEE_REFUND","RETURNED_CHECK_CHARGE","RETURNED_CHECK_REIMBURSEMENT","CASH_ADVANCE","BILL_PAY_CHARGE","CHECK_IMAGE_SERVICE_CHARGE","OVERDRAFT_PROTECTION_CHARGE","STOP_PAYMENT_CHARGE","CHECKS_ORDERING_CHARGE","MONTHLY_MAINTENANCE_CHARGE","DEBIT_CARD_FEE","CONVENIENCE_FEE","PERSONAL_LOAN_CREDIT","CREDIT_CARD_CREDIT","AUTO_LOAN","HOME_LOAN_MORTGAGE","SHORT_TERM_CREDIT","SIGNATURE_DEBIT","CONTACT_LESS_DEBIT","DEFERRED_DEPOSIT","DEFERRED_BILL_PAY","INSTALLMENT_PAYMENT","RECURRING_SUBSCRIPTION_PAYMENT","HOLD_CHECK_PAYMENT","CAPITAL_GAINS_DISTIBUTION","CG_LONG_TERM_DEPOSIT","OPEN_SALE_DEPOSIT","INTEREST__CHECK","PURCHASE_VOID","PURCHASE_WITH_CREDIT_CARD","PURCHASE_WITH_DEBIT_CARD","CHARGE_A_REPEAT_CUSTOMER","DOWN_PAYMENT_OR_ANNUITY_PAYMENT_OR_DIRECT_PAYMENT","FEE_PAYMENT","FINANCE_CHARGE_REFUND","TRANSACTION_VOID","FEE_VOID","DEBIT_CARD_WITHDRAWAL_AT_STORE","ELECTRONIC_PAYMENT","ACH_DEBIT","ATM_TELLER_DEPOSIT","POS_DEBIT","BANK_ADJUSTMENT","CHARGES_FEES","INTEREST","DEPOSITS_CREDITS","PAYMENT","PURCHASE","REFUND","TRANSFER","WITHDRAWAL","OTHER_DEPOSITS","OTHER_WITHDRAWALS","ADJUSTMENT","FINANCE_CHARGE","OTHER_CHARGES_FEES","ANNUAL_FEE","DEPOSIT","DIRECT_DEPOSIT_SALARY","INVESTMENT_INCOME_CASH","SSA","REWARDS","CHECK_DEPOSIT","MOBILE_REMOTE_DEPOSIT","TELLER_DEPOSIT","TAX_REFUND","CREDIT_CARD_PAYMENT","INSURANCE_PAYMENT","UTILITIES_PAYMENT","CHILD_SUPPORT","LOAN","PERSONAL_LOAN","STUDENT_LOAN","SALES_TAX","REIMBURSEMENT","BALANCE_TRANSFER","WIRE_TRANSFER","OVERDRAFT_PROTECTION","DEBIT","CREDIT","NSF_FEES"],"readOnly":true,"type":"string"},"symbol":{"description":"The symbol of the security being traded.
    Note: The settle date field applies only to trade-related transactions.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"transactionDate":{"description":"The date the transaction happens in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"type":{"description":"The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites.

    Applicable containers: bank,creditCard,investment
    ","readOnly":true,"type":"string"},"valoren":{"description":"It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"DataExtractsTransaction","type":"object"},"DataExtractsUser":{"properties":{"loginName":{"readOnly":true,"type":"string"}},"title":"DataExtractsUser","type":"object"},"DataExtractsUserData":{"properties":{"account":{"items":{"$ref":"#/components/schemas/DataExtractsAccount"},"readOnly":true,"type":"array"},"holding":{"items":{"$ref":"#/components/schemas/DataExtractsHolding"},"readOnly":true,"type":"array"},"providerAccount":{"items":{"$ref":"#/components/schemas/DataExtractsProviderAccount"},"readOnly":true,"type":"array"},"totalTransactionsCount":{"format":"int64","readOnly":true,"type":"integer"},"transaction":{"items":{"$ref":"#/components/schemas/DataExtractsTransaction"},"readOnly":true,"type":"array"},"user":{"$ref":"#/components/schemas/DataExtractsUser"}},"title":"DataExtractsUserData","type":"object"},"DataExtractsUserDataResponse":{"properties":{"userData":{"items":{"$ref":"#/components/schemas/DataExtractsUserData"},"readOnly":true,"type":"array"}},"title":"DataExtractsUserDataResponse","type":"object"},"DerivedCategorySummary":{"properties":{"categoryId":{"description":"Id of the category. This information is provided by transactions/categories service.

    Applicable containers: creditCard, bank, investment
    ","format":"int64","readOnly":true,"type":"integer"},"categoryName":{"description":"The name of the category.

    Applicable containers: creditCard, bank, investment
    ","readOnly":true,"type":"string"},"creditTotal":{"$ref":"#/components/schemas/Money"},"debitTotal":{"$ref":"#/components/schemas/Money"},"details":{"description":"Credit and debit summary per date.

    Applicable containers: creditCard, bank, investment
    ","items":{"$ref":"#/components/schemas/DerivedCategorySummaryDetails"},"readOnly":true,"type":"array"},"links":{"$ref":"#/components/schemas/DerivedTransactionsLinks"}},"title":"DerivedCategorySummary","type":"object"},"DerivedCategorySummaryDetails":{"properties":{"creditTotal":{"$ref":"#/components/schemas/Money"},"date":{"description":"Date on which the credit and debit transactions had occured.

    Applicable containers: creditCard, bank, investment
    ","readOnly":true,"type":"string"},"debitTotal":{"$ref":"#/components/schemas/Money"}},"title":"DerivedCategorySummaryDetails","type":"object"},"DerivedHolding":{"properties":{"accountId":{"description":"Unique identifier of the account to which the security is linked.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"accruedIncome":{"$ref":"#/components/schemas/Money"},"accruedInterest":{"$ref":"#/components/schemas/Money"},"assetClassification":{"$ref":"#/components/schemas/AssetClassification"},"contractQuantity":{"description":"The quantity of tradeable units in a contract.
    Note: The contract quantity field is only applicable to commodity and currency.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"costBasis":{"$ref":"#/components/schemas/Money"},"couponRate":{"description":"The stated interest rate for a bond.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"createdDate":{"description":"The date on which the holding is created in the Yodlee system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"cusipNumber":{"description":"The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"description":{"description":"The description (name) for the holding (E.g., Cisco Systems)
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"enrichedDescription":{"description":"The enrichedDescription is the security description of the normalized holding

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"exercisedQuantity":{"description":"The quantity of the employee stock options that are already exercised or bought by the employee.
    Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"expirationDate":{"description":"The date on which an option, right or warrant expires.
    Note: The expiration date field is only applicable to options and employee stock options.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"holdingType":{"description":"Type of holding

    Applicable containers: investment, insurance
    ","enum":["stock","mutualFund","bond","CD","option","moneyMarketFund","other","remic","future","commodity","currency","unitInvestmentTrust","employeeStockOption","insuranceAnnuity","unknown","preferredStock","ETF","warrants","ETN"],"readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the security added in the system. This is the primary key of the holding resource.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"interestRate":{"description":"The interest rate on a CD.
    Note: The interest rate field is only applicable to CD.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"isShort":{"description":"Indicates that the holding is a short trading.

    Applicable containers: investment
    ","readOnly":true,"type":"boolean"},"isin":{"description":"The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

    Note: The ISIN field is only applicable to the trade related transactions

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date when the information was last updated in the system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"matchStatus":{"description":"Indicates the security match status id of the investment option identified during security normalization.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"maturityDate":{"description":"The stated maturity date of a bond or CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"optionType":{"description":"The type of the option position (i.e., put or call).
    Note: The option type field is only applicable to options.

    Applicable containers: investment
    Applicable Values
    ","enum":["put","call","unknown","other"],"readOnly":true,"type":"string"},"price":{"$ref":"#/components/schemas/Money"},"providerAccountId":{"description":"Unique identifier for the user's association with the provider.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"quantity":{"description":"The quantity held for the holding.
    Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"securityStyle":{"description":"Indicates the security style of holding identified through the security service.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"securityType":{"description":"Indicates the security type of holding identified through the security service.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"spread":{"$ref":"#/components/schemas/Money"},"strikePrice":{"$ref":"#/components/schemas/Money"},"symbol":{"description":"The symbol of the security.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"term":{"description":"The fixed duration for which the bond or CD is issued.
    Note: The term field is only applicable to CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"unvestedQuantity":{"description":"Indicates the number of unvested quantity or units.
    Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"unvestedValue":{"$ref":"#/components/schemas/Money"},"value":{"$ref":"#/components/schemas/Money"},"vestedQuantity":{"description":"The quantity of units or shares that are already vested on a vest date.
    Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedSharesExercisable":{"description":"The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
    Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedValue":{"$ref":"#/components/schemas/Money"},"vestingDate":{"description":"The date on which a RSU, RSA, or an employee stock options become vested.
    Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"DerivedHolding","type":"object"},"DerivedHoldingSummaryResponse":{"properties":{"holdingSummary":{"items":{"$ref":"#/components/schemas/DerivedHoldingsSummary"},"readOnly":true,"type":"array"},"link":{"$ref":"#/components/schemas/DerivedHoldingsLinks"}},"title":"DerivedHoldingSummaryResponse","type":"object"},"DerivedHoldingsAccount":{"properties":{"id":{"description":"The primary key of the account resource and the unique identifier for the account.
    Required Feature Enablement: Asset classification feature.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"value":{"$ref":"#/components/schemas/Money"}},"title":"DerivedHoldingsAccount","type":"object"},"DerivedHoldingsLinks":{"properties":{"holdings":{"readOnly":true,"type":"string"}},"title":"DerivedHoldingsLinks","type":"object"},"DerivedHoldingsSummary":{"properties":{"account":{"description":"Accounts that contribute to the classification.
    Required Feature Enablement: Asset classification feature.

    Applicable containers: investment, insurance
    ","items":{"$ref":"#/components/schemas/DerivedHoldingsAccount"},"readOnly":true,"type":"array"},"classificationType":{"description":"The classification type of the security. The supported asset classification type and the values are provided in the /holdings/assetClassificationList.
    Required Feature Enablement: Asset classification feature.

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

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"holding":{"description":"Securities that belong to the asset classification type and contributed to the summary value.
    Required Feature Enablement: Asset classification feature.

    Applicable containers: investment, insurance
    ","items":{"$ref":"#/components/schemas/DerivedHolding"},"readOnly":true,"type":"array"},"value":{"$ref":"#/components/schemas/Money"}},"title":"DerivedHoldingsSummary","type":"object"},"DerivedNetworth":{"properties":{"asset":{"$ref":"#/components/schemas/Money"},"date":{"description":"The date as of when the networth information is provided.

    Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
    ","readOnly":true,"type":"string"},"historicalBalances":{"description":"Balances of the accounts over the period of time.

    Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
    ","items":{"$ref":"#/components/schemas/DerivedNetworthHistoricalBalance"},"readOnly":true,"type":"array"},"liability":{"$ref":"#/components/schemas/Money"},"networth":{"$ref":"#/components/schemas/Money"}},"title":"DerivedNetworth","type":"object"},"DerivedNetworthHistoricalBalance":{"properties":{"accountId":{"format":"int64","readOnly":true,"type":"integer"},"asOfDate":{"description":"Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system.

    Account Type: Aggregated and Manual
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    ","readOnly":true,"type":"string"},"balance":{"$ref":"#/components/schemas/Money"},"dataSourceType":{"description":"The source of balance information.

    Account Type: Aggregated and Manual
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    Applicable Values
    ","enum":["S","C","CF"],"readOnly":true,"type":"string"},"date":{"description":"Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance. AdditIonal Details: scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates. carryForward : Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc. calculated: Balances that gets calculated for the days that are prior to the account added date.

    Account Type: Aggregated and Manual
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    • GET derived/networth
    ","readOnly":true,"type":"string"},"isAsset":{"description":"Indicates whether the balance is an asset or liability.

    Account Type: Aggregated and Manual
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    ","readOnly":true,"type":"boolean"}},"title":"DerivedNetworthHistoricalBalance","type":"object"},"DerivedNetworthResponse":{"properties":{"networth":{"items":{"$ref":"#/components/schemas/DerivedNetworth"},"readOnly":true,"type":"array"}},"title":"DerivedNetworthResponse","type":"object"},"DerivedTransactionSummaryResponse":{"properties":{"links":{"$ref":"#/components/schemas/DerivedTransactionsLinks"},"transactionSummary":{"items":{"$ref":"#/components/schemas/DerivedTransactionsSummary"},"readOnly":true,"type":"array"}},"title":"DerivedTransactionSummaryResponse","type":"object"},"DerivedTransactionsLinks":{"properties":{"transactions":{"description":"Link of the transaction API service that corresponds to the value derivation.

    Applicable containers: creditCard, bank, investment
    ","readOnly":true,"type":"string"}},"title":"DerivedTransactionsLinks","type":"object"},"DerivedTransactionsSummary":{"properties":{"categorySummary":{"description":"Summary of transaction amouts at category level.

    Applicable containers: creditCard, bank, investment
    ","items":{"$ref":"#/components/schemas/DerivedCategorySummary"},"readOnly":true,"type":"array"},"categoryType":{"description":"Type of categories provided by transactions/categories service.

    Applicable containers: creditCard, bank, investment
    Applicable Values
    ","enum":["TRANSFER","DEFERRED_COMPENSATION","UNCATEGORIZE","INCOME","EXPENSE"],"readOnly":true,"type":"string"},"creditTotal":{"$ref":"#/components/schemas/Money"},"debitTotal":{"$ref":"#/components/schemas/Money"},"links":{"$ref":"#/components/schemas/DerivedTransactionsLinks"}},"title":"DerivedTransactionsSummary","type":"object"},"Description":{"properties":{"consumer":{"description":"The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field.

    Applicable containers: creditCard, insurance, loan
    ","type":"string"},"original":{"description":"Original transaction description as it appears at the FI site.

    Applicable containers: creditCard, insurance, loan
    ","readOnly":true,"type":"string"},"security":{"description":"The description will provide the actual name of the security.

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

    Applicable containers: creditCard, insurance, loan
    ","readOnly":true,"type":"string"}},"title":"Description","type":"object"},"DetailCategory":{"properties":{"id":{"description":"The unique identifier of the detail category.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"name":{"description":"The name of the detail category

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"}},"title":"DetailCategory","type":"object"},"Document":{"properties":{"accountID":{"description":"The unique identifier for the account. The account ID to which the document is linked.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"docType":{"description":"Indicates the type of the document.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","enum":["STMT","TAX","EBILL"],"readOnly":true,"type":"string"},"formType":{"description":"Indicates the type of the tax form.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"id":{"description":"The document's primary key and unique identifier.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"Indicates the date and time the document was last updated.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"name":{"description":"Indicates the name of the document.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"source":{"description":"Indicates the source of the document download.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"status":{"description":"Indicates the status of the document download.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"}},"title":"Document","type":"object"},"DocumentDownload":{"properties":{"docContent":{"description":"Contents of the document in Base64 format.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"id":{"description":"The document's primary key and unique identifier.

    Applicable containers: bank, investment, creditCard, loan, insurance
    ","readOnly":true,"type":"string"}},"title":"DocumentDownload","type":"object"},"DocumentDownloadResponse":{"properties":{"document":{"items":{"$ref":"#/components/schemas/DocumentDownload"},"readOnly":true,"type":"array"}},"title":"DocumentDownloadResponse","type":"object"},"DocumentResponse":{"properties":{"document":{"items":{"$ref":"#/components/schemas/Document"},"readOnly":true,"type":"array"}},"title":"DocumentResponse","type":"object"},"Email":{"properties":{"type":{"enum":["PRIMARY","SECONDARY","PERSONAL","WORK","OTHERS"],"readOnly":true,"type":"string"},"value":{"readOnly":true,"type":"string"}},"title":"Email","type":"object"},"EvaluateAccountAddress":{"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"sourceType":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"type":{"enum":["HOME","BUSINESS","POBOX","RETAIL","OFFICE","SMALL_BUSINESS","COMMUNICATION","PERMANENT","STATEMENT_ADDRESS","PAYMENT","PAYOFF","UNKNOWN"],"type":"string"},"zip":{"type":"string"}},"required":["street"],"title":"EvaluateAccountAddress","type":"object"},"EvaluateAddressRequest":{"properties":{"address":{"$ref":"#/components/schemas/EvaluateAccountAddress"}},"required":["address"],"title":"EvaluateAddressRequest","type":"object"},"EvaluateAddressResponse":{"properties":{"address":{"items":{"$ref":"#/components/schemas/AccountAddress"},"readOnly":true,"type":"array"},"isValidAddress":{"type":"boolean"}},"title":"EvaluateAddressResponse","type":"object"},"Field":{"properties":{"id":{"description":"Identifier for the field.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","maxLength":2147483647,"minLength":1,"type":"string"},"image":{"description":"Image displayed at the endsite.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    ","type":"string"},"isOptional":{"description":"Indicates if a field is an optional field or a mandatory field.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"boolean"},"isValueProvided":{"description":"Indicates that the answer to the security question already exists in the Yodlee system.Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided.


    Endpoints:
    • GET providerAccounts?include=questions
    • GET providerAccounts/{providerAccountId}? include=questions
    ","readOnly":true,"type":"boolean"},"maxLength":{"description":"The maximum length of the login form field.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","format":"int64","readOnly":true,"type":"integer"},"minLength":{"description":"The minimum length of the login form field.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","format":"int64","readOnly":true,"type":"integer"},"name":{"description":"Name of the field.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"},"option":{"description":"Provides the different values that are available for the user to choose. This field is applicable for drop-down or radio field types.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","items":{"$ref":"#/components/schemas/Option"},"readOnly":true,"type":"array"},"prefix":{"description":"The prefix string that has to be displayed before the field value.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"},"suffix":{"description":"The suffix string that has to be displayed next to the field value.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"},"type":{"description":"This indicates the display type of the field. For example, text box, image, etc.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    Applicable Values
    ","enum":["text","password","option","checkbox","radio","image"],"readOnly":true,"type":"string"},"value":{"description":"Value expected from the user for the field. This will be blank and is expected to be filled and sent back when submitting the login or MFA information.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"valueEditable":{"description":"Indicates whether the field is editable or not.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"}},"title":"Field","type":"object"},"FieldOperation":{"properties":{"field":{"description":"Field for which the clause is created.

    Applicable containers: bank, creditCard, investment, insurance, loan
    Applicable Values:
    • amount
    • description
    Applicable Values
    ","enum":["amount","description"],"type":"string"},"operation":{"description":"Operation for which the clause is created.

    Applicable containers: bank, creditCard, investment, insurance, loan
    Applicable values (depends on the value of field):
    • field is description -> operation can be
      1. stringEquals
      2. stringContains
    • field is amount -> operation can be
      1. numberEquals
      2. numberLessThan
      3. numberLessThanEquals
      4. numberGreaterThan
      5. numberGreaterThanEquals
    Applicable Values
    ","enum":["numberEquals","numberLessThan","numberLessThanEquals","numberGreaterThan","numberGreaterThanEquals","stringEquals","stringContains"],"type":"string"},"value":{"description":"The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause.

    Applicable containers: bank, creditCard, investment, insurance, loan
    Applicable Values:
    • field is description -> value should be min of 3 and max of 50 characters
    • field is amount -> value should be min value of 0 and a max value of 99999999999.99
    ","properties":{},"type":"object"}},"title":"FieldOperation","type":"object"},"FullAccountNumberList":{"properties":{"paymentAccountNumber":{"description":"Payment Account Number of given account.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"unmaskedAccountNumber":{"description":"Unmasked account number of given account.

    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"}},"title":"FullAccountNumberList","type":"object"},"HistoricalBalance":{"properties":{"asOfDate":{"description":"Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    ","readOnly":true,"type":"string"},"balance":{"$ref":"#/components/schemas/Money"},"dataSourceType":{"description":"The source of balance information.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    Applicable Values
    ","enum":["S","C","CF"],"readOnly":true,"type":"string"},"date":{"description":"Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance.
    Additional Details:
    Scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates.
    CarryForward: Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc.
    calculated: Balances that gets calculated for the days that are prior to the account added date.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    • GET derived/networth
    ","readOnly":true,"type":"string"},"isAsset":{"description":"Indicates whether the balance is an asset or liability.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:
    • GET accounts/historicalBalances
    ","readOnly":true,"type":"boolean"}},"title":"HistoricalBalance","type":"object"},"Holding":{"properties":{"accountId":{"description":"Unique identifier of the account to which the security is linked.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"accruedIncome":{"$ref":"#/components/schemas/Money"},"accruedInterest":{"$ref":"#/components/schemas/Money"},"assetClassification":{"description":"Asset classification applied to the holding.

    Applicable containers: investment
    ","items":{"$ref":"#/components/schemas/AssetClassification"},"readOnly":true,"type":"array"},"contractQuantity":{"description":"The quantity of tradeable units in a contract.
    Note: The contract quantity field is only applicable to commodity and currency.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"costBasis":{"$ref":"#/components/schemas/Money"},"couponRate":{"description":"The stated interest rate for a bond.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"createdDate":{"description":"The date on which the holding is created in the Yodlee system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"cusipNumber":{"description":"The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"description":{"description":"The description (name) for the holding (E.g., Cisco Systems)
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"enrichedDescription":{"description":"The enrichedDescription is the security description of the normalized holding

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"exercisedQuantity":{"description":"The quantity of the employee stock options that are already exercised or bought by the employee.
    Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"expirationDate":{"description":"The date on which an option, right or warrant expires.
    Note: The expiration date field is only applicable to options and employee stock options.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"holdingType":{"description":"Type of holding

    Applicable containers: investment, insurance
    ","enum":["stock","mutualFund","bond","CD","option","moneyMarketFund","other","remic","future","commodity","currency","unitInvestmentTrust","employeeStockOption","insuranceAnnuity","unknown","preferredStock","ETF","warrants","ETN"],"readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the security added in the system. This is the primary key of the holding resource.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"interestRate":{"description":"The interest rate on a CD.
    Note: The interest rate field is only applicable to CD.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"isShort":{"description":"Indicates that the holding is a short trading.

    Applicable containers: investment
    ","readOnly":true,"type":"boolean"},"isin":{"description":"The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

    Note: The ISIN field is only applicable to the trade related transactions

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date when the information was last updated in the system.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"matchStatus":{"description":"Indicates the security match status id of the investment option identified during security normalization.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"maturityDate":{"description":"The stated maturity date of a bond or CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"optionType":{"description":"The type of the option position (i.e., put or call).
    Note: The option type field is only applicable to options.

    Applicable containers: investment
    Applicable Values
    ","enum":["put","call","unknown","other"],"readOnly":true,"type":"string"},"price":{"$ref":"#/components/schemas/Money"},"providerAccountId":{"description":"Unique identifier for the user's association with the provider.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"quantity":{"description":"The quantity held for the holding.
    Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"securityStyle":{"description":"Indicates the security style of holding identified through the security service.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"securityType":{"description":"Indicates the security type of holding identified through the security service.

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

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"spread":{"$ref":"#/components/schemas/Money"},"strikePrice":{"$ref":"#/components/schemas/Money"},"symbol":{"description":"The symbol of the security.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"term":{"description":"The fixed duration for which the bond or CD is issued.
    Note: The term field is only applicable to CD.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"unvestedQuantity":{"description":"Indicates the number of unvested quantity or units.
    Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"unvestedValue":{"$ref":"#/components/schemas/Money"},"value":{"$ref":"#/components/schemas/Money"},"vestedQuantity":{"description":"The quantity of units or shares that are already vested on a vest date.
    Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedSharesExercisable":{"description":"The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
    Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"vestedValue":{"$ref":"#/components/schemas/Money"},"vestingDate":{"description":"The date on which a RSU, RSA, or an employee stock options become vested.
    Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"Holding","type":"object"},"HoldingAssetClassificationListResponse":{"properties":{"assetClassificationList":{"items":{"$ref":"#/components/schemas/AssetClassificationList"},"readOnly":true,"type":"array"}},"title":"HoldingAssetClassificationListResponse","type":"object"},"HoldingResponse":{"properties":{"holding":{"items":{"$ref":"#/components/schemas/Holding"},"readOnly":true,"type":"array"}},"title":"HoldingResponse","type":"object"},"HoldingSecuritiesResponse":{"properties":{"holding":{"items":{"$ref":"#/components/schemas/SecurityHolding"},"readOnly":true,"type":"array"}},"title":"HoldingSecuritiesResponse","type":"object"},"HoldingTypeListResponse":{"properties":{"holdingType":{"items":{"enum":["stock","mutualFund","bond","CD","option","moneyMarketFund","other","remic","future","commodity","currency","unitInvestmentTrust","employeeStockOption","insuranceAnnuity","unknown","preferredStock","ETF","warrants","ETN"],"type":"string"},"readOnly":true,"type":"array"}},"title":"HoldingTypeListResponse","type":"object"},"Identifier":{"properties":{"type":{"description":"Type of Identifier","enum":["NIE","DNI","EIN","BN","AADHAR","NIN","NRIC"],"readOnly":true,"type":"string"},"value":{"description":"Value of the identifier","readOnly":true,"type":"string"}},"title":"Identifier","type":"object"},"LoanPayoffDetails":{"properties":{"outstandingBalance":{"$ref":"#/components/schemas/Money"},"payByDate":{"description":"The date by which the payoff amount should be paid.

    Account Type: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","readOnly":true,"type":"string"},"payoffAmount":{"$ref":"#/components/schemas/Money"}},"title":"LoanPayoffDetails","type":"object"},"LoginForm":{"properties":{"forgetPasswordURL":{"description":"The forget password URL of the provider site.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"formType":{"description":"The type of the forms for which the user information is required.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    Applicable Values
    ","enum":["login","questionAndAnswer","token","image"],"type":"string"},"help":{"description":"The help that can be displayed to the customer in the login form.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"},"id":{"description":"The identifier of the login form.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","format":"int64","type":"integer"},"loginHelp":{"description":"The help that can be displayed to the customer in the login form.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","readOnly":true,"type":"string"},"mfaInfoText":{"description":"The text displayed in the provider site while requesting the user's MFA information. This field is applicable for MFA form types only.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"mfaInfoTitle":{"description":"The title for the MFA information demanded from the user.This is the title displayed in the provider site.This field is applicable for MFA form types only.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"mfaTimeout":{"description":"The amount of time before which the user is expected to provide MFA information. This field is applicable for MFA form types only. This would be an useful information that could be displayed to the users.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","format":"int64","readOnly":true,"type":"integer"},"row":{"description":"This indicates one row in the form. The row will have one label. But it may have single or multiple fields.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","items":{"$ref":"#/components/schemas/Row"},"type":"array"}},"title":"LoginForm","type":"object"},"Merchant":{"properties":{"address":{"$ref":"#/components/schemas/AccountAddress"},"categoryLabel":{"description":"The business categories of the merchant.

    Applicable containers: bank,creditCard
    Applicable Values
    ","items":{"type":"string"},"readOnly":true,"type":"array"},"contact":{"$ref":"#/components/schemas/Contact"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"id":{"description":"Identifier of the merchant.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"name":{"description":"The name of the merchant.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"source":{"description":"The source through which merchant information is retrieved.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["YODLEE","FACTUAL"],"readOnly":true,"type":"string"},"website":{"description":"The website of the merchant.

    Applicable containers: bank,creditCard,investment,loan
    ","readOnly":true,"type":"string"}},"title":"Merchant","type":"object"},"Money":{"properties":{"amount":{"format":"double","type":"number"},"currency":{"enum":["AUD","BRL","CAD","EUR","GBP","HKD","IDR","INR","JPY","NZD","SGD","USD","ZAR","CNY","VND","MYR","CHF"],"type":"string"}},"required":["amount","currency"],"title":"Money","type":"object"},"Name":{"properties":{"first":{"type":"string"},"fullName":{"type":"string"},"last":{"type":"string"},"middle":{"type":"string"}},"title":"Name","type":"object"},"Option":{"properties":{"displayText":{"description":"The text that is displayed to the user for that option in the provider site.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"isSelected":{"description":"The option that is selected by default in the provider site.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"boolean"},"optionValue":{"description":"The value that is associated with the option.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"}},"title":"Option","type":"object"},"PaymentBankTransferCode":{"properties":{"id":{"description":"Value of the identifier","readOnly":true,"type":"string"},"type":{"description":"Type of BankTransferCode","enum":["ROUTING_NUMBER","BSB","IFSC","SORT_CODE"],"readOnly":true,"type":"string"}},"title":"PaymentBankTransferCode","type":"object"},"PaymentIdentifier":{"properties":{"type":{"description":"Type of Identifier","enum":["REFERENCE_NUMBER","PLATFORM_CODE"],"readOnly":true,"type":"string"},"value":{"description":"Value of the identifier","readOnly":true,"type":"string"}},"title":"PaymentIdentifier","type":"object"},"PaymentProfile":{"properties":{"address":{"description":"The address of the lender to which the monthly payments or the loan payoff amount should be paid.
    Additional Details:The address field applies only to the student loan account type.
    Account Type: Aggregated
    Applicable containers: loan
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/AccountAddress"},"type":"array"},"identifier":{"$ref":"#/components/schemas/PaymentIdentifier"},"paymentBankTransferCode":{"$ref":"#/components/schemas/PaymentBankTransferCode"}},"title":"PaymentProfile","type":"object"},"PhoneNumber":{"properties":{"type":{"description":"type of phone number","enum":["HOME","WORK","LANDLINE","MOBILE"],"readOnly":true,"type":"string"},"value":{"description":"Phone Number","readOnly":true,"type":"string"}},"title":"PhoneNumber","type":"object"},"Profile":{"properties":{"address":{"description":"Address available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/AccountAddress"},"readOnly":true,"type":"array"},"email":{"description":"Email Id available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/Email"},"readOnly":true,"type":"array"},"gender":{"description":"Gender of the provider account holder.

    Aggregated / Manual: Aggregated
    Endpoints:
    • GET providerAccounts/profile
    ","readOnly":true,"type":"string"},"identifier":{"description":"Identifiers available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/Identifier"},"readOnly":true,"type":"array"},"name":{"$ref":"#/components/schemas/Name"},"phoneNumber":{"description":"Phone number available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    ","items":{"$ref":"#/components/schemas/PhoneNumber"},"readOnly":true,"type":"array"}},"title":"Profile","type":"object"},"ProviderAccount":{"properties":{"aggregationSource":{"description":"The source through which the providerAccount is added in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"consentId":{"description":"Consent Id generated through POST Consent.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","format":"int64","type":"integer"},"createdDate":{"description":"The date on when the provider account is created in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"id":{"description":"Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"isManual":{"description":"Indicates whether account is a manual or aggregated provider account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastUpdated":{"description":"Indicate when the providerAccount is last updated successfully.

    Account Type: Aggregated
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"oauthMigrationStatus":{"description":"Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET providerAccounts
    • GET providerAccounts/{providerAccountId}
    • PUT providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"preferences":{"$ref":"#/components/schemas/ProviderAccountPreferences"},"providerId":{"description":"Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"requestId":{"description":"Unique id generated to indicate the request.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"status":{"description":"The status of last update attempted for the account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["LOGIN_IN_PROGRESS","USER_INPUT_REQUIRED","IN_PROGRESS","PARTIAL_SUCCESS","SUCCESS","FAILED","MIGRATION_IN_PROGRESS"],"readOnly":true,"type":"string"}},"title":"ProviderAccount","type":"object"},"ProviderAccountDetail":{"properties":{"aggregationSource":{"description":"The source through which the providerAccount is added in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"consentId":{"description":"Consent Id generated through POST Consent.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","format":"int64","type":"integer"},"createdDate":{"description":"The date on when the provider account is created in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"id":{"description":"Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"isManual":{"description":"Indicates whether account is a manual or aggregated provider account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastUpdated":{"description":"Indicate when the providerAccount is last updated successfully.

    Account Type: Aggregated
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"loginForm":{"description":"This entity gets returned in the response for only MFA based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of MFA form that is displayed to the user in the provider site.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","items":{"$ref":"#/components/schemas/LoginForm"},"readOnly":true,"type":"array"},"oauthMigrationStatus":{"description":"Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET providerAccounts
    • GET providerAccounts/{providerAccountId}
    • PUT providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"preferences":{"$ref":"#/components/schemas/ProviderAccountPreferences"},"providerId":{"description":"Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"requestId":{"description":"Unique id generated to indicate the request.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"status":{"description":"The status of last update attempted for the account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["LOGIN_IN_PROGRESS","USER_INPUT_REQUIRED","IN_PROGRESS","PARTIAL_SUCCESS","SUCCESS","FAILED","MIGRATION_IN_PROGRESS"],"readOnly":true,"type":"string"}},"required":["consentId"],"title":"ProviderAccountDetail","type":"object"},"ProviderAccountDetailResponse":{"properties":{"providerAccount":{"items":{"$ref":"#/components/schemas/ProviderAccountDetail"},"readOnly":true,"type":"array"}},"title":"ProviderAccountDetailResponse","type":"object"},"ProviderAccountPreferences":{"properties":{"isAutoRefreshEnabled":{"description":"Indicates if auto-refreshes have to be triggered for the provider account.

    Endpoints:
    • GET providerAccounts?include=preferences
    • GET providerAccounts/{providerAccountId}?include=preferences
    ","type":"boolean"},"isDataExtractsEnabled":{"description":"Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.

    Endpoints:
    • GET providerAccounts?include=preferences
    • GET providerAccounts/{providerAccountId}?include=preferences
    ","type":"boolean"},"linkedProviderAccountId":{"description":"LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account.
    LinkedProviderAccountId and the providerAccountId belongs to the same institution.

    Endpoints:
    • POST Provider Account
    • PUT Provider Account
    • GET Provider Accounts
    ","format":"int64","type":"integer"}},"title":"ProviderAccountPreferences","type":"object"},"ProviderAccountPreferencesRequest":{"properties":{"preferences":{"$ref":"#/components/schemas/ProviderAccountPreferences"}},"title":"ProviderAccountPreferencesRequest","type":"object"},"ProviderAccountProfile":{"properties":{"id":{"description":"Unique identifier for profile

    Endpoints:
    • GET providerAccounts/profile
    ","format":"int64","readOnly":true,"type":"integer"},"profile":{"description":"PII related data like address, name, phoneNumber, identifier and email.

    Endpoints:
    • GET providerAccounts/profile
    ","items":{"$ref":"#/components/schemas/Profile"},"readOnly":true,"type":"array"}},"title":"ProviderAccountProfile","type":"object"},"ProviderAccountRequest":{"properties":{"aggregationSource":{"enum":["SYSTEM","USER"],"type":"string"},"consentId":{"description":"Consent Id generated for the request through POST Consent.

    Endpoints:
    • POST Provider Account
    • PUT Provider Account
    ","format":"int64","type":"integer"},"dataset":{"items":{"$ref":"#/components/schemas/ProvidersDataset"},"type":"array"},"datasetName":{"items":{"enum":["BASIC_AGG_DATA","ADVANCE_AGG_DATA","ACCT_PROFILE","DOCUMENT"],"type":"string"},"type":"array"},"field":{"items":{"$ref":"#/components/schemas/Field"},"type":"array"},"preferences":{"$ref":"#/components/schemas/ProviderAccountPreferences"}},"required":["field"],"title":"ProviderAccountRequest","type":"object"},"ProviderAccountResponse":{"properties":{"providerAccount":{"items":{"$ref":"#/components/schemas/ProviderAccount"},"readOnly":true,"type":"array"}},"title":"ProviderAccountResponse","type":"object"},"ProviderAccountUserProfileResponse":{"properties":{"providerAccount":{"items":{"$ref":"#/components/schemas/ProviderAccountProfile"},"readOnly":true,"type":"array"}},"title":"ProviderAccountUserProfileResponse","type":"object"},"ProviderDetail":{"properties":{"PRIORITY":{"description":"Indicates the priority for which the service is invoked.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["POPULAR","SUGGESTED","COBRAND","SEARCH","ALL"],"readOnly":true,"type":"string"},"accountType":{"description":"AccountType supported by the provider, eg: Brokerage Cash, Current

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"enum":["CURRENT","BROKERAGE_CASH"],"type":"string"},"readOnly":true,"type":"array"},"associatedProviderIds":{"description":"The screen-scraping providers that are associated to the Open Banking provider ID.

    Applicable containers: All Containers
    Endpoints:
    • GET providers
    • GET providers/{providerId}
    ","items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"authParameter":{"description":"AuthParameter appears in the response only in case of token-based aggregation sites.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"enum":["authorizationCode","idToken","authResponse"],"type":"string"},"readOnly":true,"type":"array"},"authType":{"description":"The authentication type enabled at the provider site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["OAUTH","CREDENTIALS","MFA_CREDENTIALS"],"readOnly":true,"type":"string"},"baseUrl":{"description":"The base URL of the provider's site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"capability":{"description":"Capability of the site

    Endpoints:
    • GET providers/{providerId}
    • GET providers

    Note : capability has been deprecated","items":{"$ref":"#/components/schemas/Capability"},"readOnly":true,"type":"array"},"countryISOCode":{"description":"Country to which the provider belongs.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"$ref":"#/components/schemas/ProvidersDataset"},"readOnly":true,"type":"array"},"favicon":{"description":"Favicon link of the provider.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"help":{"description":"Text to guide user through linking an account that belongs to the site

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the provider site(e.g., financial institution sites, biller sites, lender sites, etc.).

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","format":"int64","readOnly":true,"type":"integer"},"isAddedByUser":{"description":"Indicates that the site has been added by the user at least once.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"isAutoRefreshEnabled":{"description":"Indicates if a provider site is auto-refreshed.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"boolean"},"isConsentRequired":{"description":"Indicates if a provider site requires consent.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"boolean"},"languageISOCode":{"description":"The language in which the provider details are provided. For example, a site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user's locale. The language follows the two letter ISO code.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"lastModified":{"description":"Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"loginForm":{"description":"This entity represents the structure of the login or MFA form that is displayed to the user at the provider site. For performance reasons, this field is returned only when a single provider is requested in the request.

    Endpoints:
    • GET providers/{providerId}
    ","items":{"$ref":"#/components/schemas/LoginForm"},"readOnly":true,"type":"array"},"loginUrl":{"description":"The login URL of the provider's site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"logo":{"description":"The logo link of the provider institution. The link will return the logo in the PNG format.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"name":{"description":"The name of a provider site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"primaryLanguageISOCode":{"description":"The primary language of the site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"status":{"description":"Determines if the provider is supported for the cobrand (customer), is in the beta stage, etc.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","enum":["Supported","Beta","Unsupported"],"readOnly":true,"type":"string"}},"title":"ProviderDetail","type":"object"},"ProviderDetailResponse":{"properties":{"provider":{"items":{"$ref":"#/components/schemas/ProviderDetail"},"readOnly":true,"type":"array"}},"title":"ProviderDetailResponse","type":"object"},"ProviderResponse":{"properties":{"provider":{"items":{"$ref":"#/components/schemas/Providers"},"readOnly":true,"type":"array"}},"title":"ProviderResponse","type":"object"},"Providers":{"properties":{"PRIORITY":{"description":"Indicates the priority for which the service is invoked.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["POPULAR","SUGGESTED","COBRAND","SEARCH","ALL"],"readOnly":true,"type":"string"},"accountType":{"description":"AccountType supported by the provider, eg: Brokerage Cash, Current

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"enum":["CURRENT","BROKERAGE_CASH"],"type":"string"},"readOnly":true,"type":"array"},"associatedProviderIds":{"description":"The screen-scraping providers that are associated to the Open Banking provider ID.

    Applicable containers: All Containers
    Endpoints:
    • GET providers
    • GET providers/{providerId}
    ","items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"authParameter":{"description":"AuthParameter appears in the response only in case of token-based aggregation sites.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"enum":["authorizationCode","idToken","authResponse"],"type":"string"},"readOnly":true,"type":"array"},"authType":{"description":"The authentication type enabled at the provider site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["OAUTH","CREDENTIALS","MFA_CREDENTIALS"],"readOnly":true,"type":"string"},"baseUrl":{"description":"The base URL of the provider's site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"capability":{"description":"Capability of the site

    Endpoints:
    • GET providers/{providerId}
    • GET providers

    Note : capability has been deprecated","items":{"$ref":"#/components/schemas/Capability"},"readOnly":true,"type":"array"},"countryISOCode":{"description":"Country to which the provider belongs.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"$ref":"#/components/schemas/ProvidersDataset"},"readOnly":true,"type":"array"},"favicon":{"description":"Favicon link of the provider.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"forgetPasswordUrl":{"description":"The forget password URL of the provider site.

    Endpoints:
    • GET providers
    ","readOnly":true,"type":"string"},"help":{"description":"Text to guide user through linking an account that belongs to the site

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the provider site(e.g., financial institution sites, biller sites, lender sites, etc.).

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","format":"int64","readOnly":true,"type":"integer"},"isAddedByUser":{"description":"Indicates that the site has been added by the user at least once.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"isAutoRefreshEnabled":{"description":"Indicates if a provider site is auto-refreshed.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"boolean"},"isConsentRequired":{"description":"Indicates if a provider site requires consent.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"boolean"},"languageISOCode":{"description":"The language in which the provider details are provided. For example, a site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user's locale. The language follows the two letter ISO code.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"lastModified":{"description":"Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"loginHelp":{"description":"Help text to guide the user to choose the correct provider site.

    Endpoints:
    • GET providers
    ","readOnly":true,"type":"string"},"loginUrl":{"description":"The login URL of the provider's site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"logo":{"description":"The logo link of the provider institution. The link will return the logo in the PNG format.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"name":{"description":"The name of a provider site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"primaryLanguageISOCode":{"description":"The primary language of the site.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","readOnly":true,"type":"string"},"status":{"description":"Determines if the provider is supported for the cobrand (customer), is in the beta stage, etc.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","enum":["Supported","Beta","Unsupported"],"readOnly":true,"type":"string"}},"title":"Providers","type":"object"},"ProvidersCount":{"properties":{"TOTAL":{"$ref":"#/components/schemas/TotalCount"}},"title":"ProvidersCount","type":"object"},"ProvidersCountResponse":{"properties":{"provider":{"$ref":"#/components/schemas/ProvidersCount"}},"title":"ProvidersCountResponse","type":"object"},"ProvidersDataset":{"properties":{"attribute":{"description":"The name of the dataset attribute suported by the provider.

    Endpoints:
    • GET providers/{providerId}
    • GET providers
    ","items":{"$ref":"#/components/schemas/Attribute"},"type":"array"},"name":{"description":"The name of the dataset requested from the provider site

    Account Type: Manual
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    • GET providers
    Applicable Values
    ","enum":["BASIC_AGG_DATA","ADVANCE_AGG_DATA","ACCT_PROFILE","DOCUMENT"],"type":"string"}},"title":"ProvidersDataset","type":"object"},"RewardBalance":{"properties":{"balance":{"description":"The actual reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","format":"double","readOnly":true,"type":"number"},"balanceToLevel":{"description":"The balance required to reach a reward level.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"balanceToReward":{"description":"The balance required to qualify for a reward such as retaining membership, business reward, etc.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"balanceType":{"description":"The type of reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["EXPIRING_BALANCE","BALANCE_TO_LEVEL","BALANCE_TO_REWARD","BALANCE","TOTAL_BALANCE"],"readOnly":true,"type":"string"},"description":{"description":"The description for the reward balance as available at provider source.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"expiryDate":{"description":"The date on which the balance expires.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"units":{"description":"Unit of reward balance - miles, points, segments, dollars, credits.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"}},"title":"RewardBalance","type":"object"},"Row":{"properties":{"field":{"description":"Details of fields that belong to the row.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","items":{"$ref":"#/components/schemas/Field"},"type":"array"},"fieldRowChoice":{"description":"Fields that belong to a particular choice are collected together using this field.
    Recommendations: All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. First field choice could be selected by default.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"form":{"description":"Form denotes the set of the fields that are related.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"id":{"description":"Unique identifier of the row.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"},"label":{"description":"The label text displayed for a row in the form.

    Endpoints:
    • GET providerAccounts/{providerAccountId}
    • GET providers/{providerId}
    ","type":"string"}},"title":"Row","type":"object"},"RuleClause":{"properties":{"field":{"description":"Field for which the clause is created.


    Valid Values:amount,descriptionApplicable containers: creditCard, investment, insurance, loan
    ","enum":["amount","description"],"readOnly":true,"type":"string"},"fieldValue":{"description":"The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause.

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"},"operation":{"description":"Operation for which the clause is created.

    Applicable containers: creditCard, investment, insurance, loan
    ","enum":["numberEquals","numberLessThan","numberLessThanEquals","numberGreaterThan","numberGreaterThanEquals","stringEquals","stringContains"],"readOnly":true,"type":"string"},"ruleClauseId":{"description":"Unique identifier generated for the rule clause.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"userDefinedRuleId":{"description":"Unique identifier generated for every rule the user creates.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"}},"title":"RuleClause","type":"object"},"Security":{"properties":{"accrualMethod":{"description":"The method in which interest is accrued or earned.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"agencyFactor":{"description":"Agency factor of the security.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"callDate":{"description":"Next call date of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"callPrice":{"description":"Next call price of the security.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"cdscFundFlag":{"description":"cdsc fund flag of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"closedFlag":{"description":"true:Closed for all investors , false: Open to all investors.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"cusip":{"description":"A CUSIP is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"description":{"description":"The description (name) of the security. For example, Cisco Systems.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"federalTaxable":{"description":"Flag indicating federal taxable.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"firmEligible":{"description":"1- indicates Eligible,0- indicates firm is not eligible.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"firstCouponDate":{"description":"First coupon date of security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"frequency":{"description":"Coupon Frequency.

    Applicable containers: investment, insurance
    ","format":"int32","readOnly":true,"type":"integer"},"fundFamily":{"description":"Mutual Fund Family Name.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"gicsSector":{"description":"GICS Sector is a categorization the S&P assigns to all publically traded companies.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"id":{"description":"The unique identifier of the security.

    Applicable containers: investment, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"incomeCurrency":{"description":"ISO 4217 currency code indicating income currency of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"interestRate":{"description":"The rate of interest paid annually, expressed as a percentage of the bond's par or face value.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"isDummySecurity":{"description":"Indicates whether the security is a dummy security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"isEnvestnetDummySecurity":{"description":"Flag indicating a dummy security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"isSyntheticSecurity":{"description":"Indicates whether the security is a simulated security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"isin":{"description":"The International Securities Identification Number (ISIN) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"issueDate":{"description":"Issue date of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"issueTypeMultiplier":{"description":"Price units corresponding to the security style. This is used to derive actual price of the security from market value.

    Applicable containers: investment, insurance
    ","format":"double","readOnly":true,"type":"number"},"lastCouponDate":{"description":"Last coupon date of security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"lastModifiedDate":{"description":"The last updated date of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"maturityDate":{"description":"Maturity date of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"minimumPurchase":{"description":"Minimum purchase of security.

    Applicable containers: investment, insurance
    ","format":"int32","readOnly":true,"type":"integer"},"moodyRating":{"description":"Unique identifier for Moody rating on Envestnet platform.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"sAndPRating":{"description":"Unique identifier for S&P rating on Envestnet platform.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"sector":{"description":"Identifier of the sector to which the security belongs to.

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

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"shareClass":{"description":"Share class of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"stateTaxable":{"description":"The state in which the security is taxed.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"boolean"},"stockExchangeDetails":{"description":"Securities exchange provide the securities information at the corresponding exchanges.

    Applicable containers: investment, insurance
    ","items":{"$ref":"#/components/schemas/StockExchangeDetail"},"readOnly":true,"type":"array"},"style":{"description":"Classification of the style for the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"subSector":{"description":"GICS sector ID to which the security belongs to.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"tradeCurrencyCode":{"description":"ISO 4217 currency code indicating trading currency of the security.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"type":{"description":"Indicates the type of security like stocks, mutual fund, etc.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"}},"title":"Security","type":"object"},"SecurityHolding":{"properties":{"id":{"readOnly":true,"type":"string"},"security":{"$ref":"#/components/schemas/Security"}},"title":"SecurityHolding","type":"object"},"Statement":{"properties":{"accountId":{"description":"Account to which the statement belongs to.

    Applicable containers: creditCard, loan, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"amountDue":{"$ref":"#/components/schemas/Money"},"apr":{"description":"The APR applied to the balance on the credit card account, as available in the statement.
    Note: In case of variable APR, the APR available on the statement might differ from the APR available at the account-level.

    Applicable containers: creditCard, loan, insurance
    ","format":"double","readOnly":true,"type":"number"},"billingPeriodEnd":{"description":"The end date of the statement period.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"billingPeriodStart":{"description":"The start date of the statement period.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"cashAdvance":{"$ref":"#/components/schemas/Money"},"cashApr":{"description":"The APR applicable to cash withdrawals on the credit card account.

    Applicable containers: creditCard, loan, insurance
    ","format":"double","readOnly":true,"type":"number"},"dueDate":{"description":"The date by when the minimum payment is due to be paid.
    Note: The due date that appears in the statement may differ from the due date at the account-level.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"id":{"description":"Unique identifier for the statement.

    Applicable containers: creditCard, loan, insurance
    ","format":"int64","readOnly":true,"type":"integer"},"interestAmount":{"$ref":"#/components/schemas/Money"},"isLatest":{"description":"The field is set to true if the statement is the latest generated statement.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"boolean"},"lastPaymentAmount":{"$ref":"#/components/schemas/Money"},"lastPaymentDate":{"description":"The date on which the last payment was done during the billing cycle.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"lastUpdated":{"description":"The date when the account was last updated by Yodlee.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"},"loanBalance":{"$ref":"#/components/schemas/Money"},"minimumPayment":{"$ref":"#/components/schemas/Money"},"newCharges":{"$ref":"#/components/schemas/Money"},"principalAmount":{"$ref":"#/components/schemas/Money"},"statementDate":{"description":"The date on which the statement is generated.

    Applicable containers: creditCard, loan, insurance
    ","readOnly":true,"type":"string"}},"title":"Statement","type":"object"},"StatementResponse":{"properties":{"statement":{"items":{"$ref":"#/components/schemas/Statement"},"readOnly":true,"type":"array"}},"title":"StatementResponse","type":"object"},"StockExchangeDetail":{"properties":{"countryCode":{"description":"Country codes are geocodes developed to represent countries and dependent areas.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"currencyCode":{"description":"ISO codes of currency.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"exchangeCode":{"description":"An Exchange code is a four-character code used to identify stock markets and other trading exchanges within global trading.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"},"symbol":{"description":"Ticker symbol representing particular securities listed on an exchange.

    Applicable containers: investment, insurance
    ","readOnly":true,"type":"string"}},"title":"StockExchangeDetail","type":"object"},"TotalCount":{"properties":{"count":{"format":"int64","readOnly":true,"type":"integer"}},"title":"TotalCount","type":"object"},"Transaction":{"properties":{"CONTAINER":{"description":"The account's container.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"readOnly":true,"type":"string"},"accountId":{"description":"The account from which the transaction was made. This is basically the primary key of the account resource.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"amount":{"$ref":"#/components/schemas/Money"},"baseType":{"description":"Indicates if the transaction appears as a debit or a credit transaction in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["CREDIT","DEBIT"],"readOnly":true,"type":"string"},"category":{"description":"The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"categoryId":{"description":"The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"categorySource":{"description":"Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"categoryType":{"description":"The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","enum":["TRANSFER","DEFERRED_COMPENSATION","UNCATEGORIZE","INCOME","EXPENSE"],"readOnly":true,"type":"string"},"checkNumber":{"description":"The checkNumber of the transaction.

    Applicable containers: bank
    ","readOnly":true,"type":"string"},"commission":{"$ref":"#/components/schemas/Money"},"createdDate":{"readOnly":true,"type":"string"},"cusipNumber":{"description":"The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.

    Note    : The CUSIP number field applies only to trade related transactions.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"date":{"description":"The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"description":{"$ref":"#/components/schemas/Description"},"detailCategoryId":{"description":"The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories.

    Applicable containers: bank,creditCard
    ","format":"int64","readOnly":true,"type":"integer"},"highLevelCategoryId":{"description":"The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"holdingDescription":{"description":"For transactions involving securities, this captures the securities description.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"id":{"description":"An unique identifier for the transaction. The combination of the id and account container are unique in the system.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"interest":{"$ref":"#/components/schemas/Money"},"isManual":{"description":"Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"boolean"},"isin":{"description":"International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"lastUpdated":{"readOnly":true,"type":"string"},"memo":{"description":"Additional notes provided by the user for a particular transaction through application or API services.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"merchant":{"$ref":"#/components/schemas/Merchant"},"parentCategoryId":{"description":"The parentCategoryId of the category assigned to the transaction.
    Note: This field will be provided in the response if the transaction is assigned to a user-created category.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","format":"int64","readOnly":true,"type":"integer"},"postDate":{"description":"The date on which the transaction is posted to the account.

    Applicable containers: bank,creditCard,insurance,loan
    ","readOnly":true,"type":"string"},"price":{"$ref":"#/components/schemas/Money"},"principal":{"$ref":"#/components/schemas/Money"},"quantity":{"description":"The quantity associated with the transaction.
    Note: The quantity field applies only to trade-related transactions.

    Applicable containers: investment
    ","format":"double","readOnly":true,"type":"number"},"runningBalance":{"$ref":"#/components/schemas/Money"},"sedol":{"description":"SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"settleDate":{"description":"It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"sourceId":{"description":"A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.
    Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.","readOnly":true,"type":"string"},"sourceType":{"description":"The source through which the transaction is added to the Yodlee system.

    Applicable containers: bank,creditCard,investment,insurance,loann
    Applicable Values:
    ","enum":["AGGREGATED","MANUAL"],"readOnly":true,"type":"string"},"status":{"description":"The status of the transaction: pending or posted.
    Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ","enum":["POSTED","PENDING","SCHEDULED","FAILED","CLEARED"],"readOnly":true,"type":"string"},"subType":{"description":"The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","enum":["AUTH_HOLD","AUTH_REQUEST","OVERDRAFT_CHARGE","CREDIT_ADJUSTMENT","PIN_DEBIT","BANK_DIRECT_DEPOSIT","DIVIDEND_DEPOSIT","INTEREST_SAVINGS","INTEREST_ADJUSTMENT","ONLINE_PURCHASE","PURCHASED_WITH_CHECK","RECURRING_BILLING","TAX_PAYMENT","PAYMENT_BY_CHECK","PAYMENT_PLAN","FEE_REFUND","WIRE_TRANSFER_CHARGE","ACCOUNT_TO_ACCOUNT_TRANSFER","BANK_TO_BANK_TRANSACTION","BANK_TO_NON_BANK_ACCOUNT_TRANSFER","CASH_WITHDRAWAL_AT_FI","ATM_CASH_WITHDRAWAL","AUTH_PROCESSING","AUTH_RELEASE","PRE_AUTH","AUTH_COMPLETE","AUTH_VOID","BALANCE_ENQUIRY","ACCOUNT_VERIFICATION","PRE_AUTH_COMPLETION","SERVICE_CHARGE","SERVICE_CHARGE_FEE_REFUND","RETURNED_CHECK_CHARGE","RETURNED_CHECK_REIMBURSEMENT","CASH_ADVANCE","BILL_PAY_CHARGE","CHECK_IMAGE_SERVICE_CHARGE","OVERDRAFT_PROTECTION_CHARGE","STOP_PAYMENT_CHARGE","CHECKS_ORDERING_CHARGE","MONTHLY_MAINTENANCE_CHARGE","DEBIT_CARD_FEE","CONVENIENCE_FEE","PERSONAL_LOAN_CREDIT","CREDIT_CARD_CREDIT","AUTO_LOAN","HOME_LOAN_MORTGAGE","SHORT_TERM_CREDIT","SIGNATURE_DEBIT","CONTACT_LESS_DEBIT","DEFERRED_DEPOSIT","DEFERRED_BILL_PAY","INSTALLMENT_PAYMENT","RECURRING_SUBSCRIPTION_PAYMENT","HOLD_CHECK_PAYMENT","CAPITAL_GAINS_DISTIBUTION","CG_LONG_TERM_DEPOSIT","OPEN_SALE_DEPOSIT","INTEREST__CHECK","PURCHASE_VOID","PURCHASE_WITH_CREDIT_CARD","PURCHASE_WITH_DEBIT_CARD","CHARGE_A_REPEAT_CUSTOMER","DOWN_PAYMENT_OR_ANNUITY_PAYMENT_OR_DIRECT_PAYMENT","FEE_PAYMENT","FINANCE_CHARGE_REFUND","TRANSACTION_VOID","FEE_VOID","DEBIT_CARD_WITHDRAWAL_AT_STORE","ELECTRONIC_PAYMENT","ACH_DEBIT","ATM_TELLER_DEPOSIT","POS_DEBIT","BANK_ADJUSTMENT","CHARGES_FEES","INTEREST","DEPOSITS_CREDITS","PAYMENT","PURCHASE","REFUND","TRANSFER","WITHDRAWAL","OTHER_DEPOSITS","OTHER_WITHDRAWALS","ADJUSTMENT","FINANCE_CHARGE","OTHER_CHARGES_FEES","ANNUAL_FEE","DEPOSIT","DIRECT_DEPOSIT_SALARY","INVESTMENT_INCOME_CASH","SSA","REWARDS","CHECK_DEPOSIT","MOBILE_REMOTE_DEPOSIT","TELLER_DEPOSIT","TAX_REFUND","CREDIT_CARD_PAYMENT","INSURANCE_PAYMENT","UTILITIES_PAYMENT","CHILD_SUPPORT","LOAN","PERSONAL_LOAN","STUDENT_LOAN","SALES_TAX","REIMBURSEMENT","BALANCE_TRANSFER","WIRE_TRANSFER","OVERDRAFT_PROTECTION","DEBIT","CREDIT","NSF_FEES"],"readOnly":true,"type":"string"},"symbol":{"description":"The symbol of the security being traded.
    Note: The settle date field applies only to trade-related transactions.

    Applicable containers: investment
    ","readOnly":true,"type":"string"},"transactionDate":{"description":"The date the transaction happens in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ","readOnly":true,"type":"string"},"type":{"description":"The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites.

    Applicable containers: bank,creditCard,investment
    ","readOnly":true,"type":"string"},"valoren":{"description":"It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.

    Applicable containers: investment
    ","readOnly":true,"type":"string"}},"title":"Transaction","type":"object"},"TransactionCategorizationRule":{"properties":{"categoryLevelId":{"description":"The level of the category for which the rule is created.

    Applicable containers: creditCard, insurance, loan
    ","format":"int32","readOnly":true,"type":"integer"},"memId":{"description":"Unique identifier of the user.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"ruleClauses":{"description":"Details of rules.

    Applicable containers: creditCard, investment, insurance, loan
    ","items":{"$ref":"#/components/schemas/RuleClause"},"readOnly":true,"type":"array"},"rulePriority":{"description":"The order in which the rules get executed on transactions.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int32","readOnly":true,"type":"integer"},"transactionCategorisationId":{"description":"Category id that is assigned to the transaction when the transaction matches the rule clause. This is the id field of the transaction category resource.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"userDefinedRuleId":{"description":"Unique identifier generated for every rule the user creates.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"}},"title":"TransactionCategorizationRule","type":"object"},"TransactionCategorizationRuleInfo":{"properties":{"categoryId":{"format":"int32","type":"integer"},"priority":{"format":"int32","type":"integer"},"ruleClause":{"items":{"$ref":"#/components/schemas/FieldOperation"},"type":"array"},"source":{"enum":["SYSTEM","USER"],"type":"string"}},"required":["categoryId","ruleClause"],"title":"TransactionCategorizationRuleInfo","type":"object"},"TransactionCategorizationRuleRequest":{"properties":{"rule":{"$ref":"#/components/schemas/TransactionCategorizationRuleInfo"}},"required":["rule"],"title":"TransactionCategorizationRuleRequest","type":"object"},"TransactionCategorizationRuleResponse":{"properties":{"txnRules":{"items":{"$ref":"#/components/schemas/TransactionCategorizationRule"},"readOnly":true,"type":"array"}},"title":"TransactionCategorizationRuleResponse","type":"object"},"TransactionCategory":{"properties":{"category":{"description":"The name of the category.
    Note: Transaction categorization is one of the core features offered by Yodlee and the categories are assigned to the transactions by the system. Transactions can be clubbed together by the category that is assigned to them.

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"},"classification":{"description":"Category Classification.

    Applicable containers: creditCard, investment, insurance, loan
    Applicable Values
    ","enum":["PERSONAL","BUSINESS"],"readOnly":true,"type":"string"},"defaultCategoryName":{"description":"A attribute which will always hold the first value(initial name) of Yodlee defined category attribute.

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"},"defaultHighLevelCategoryName":{"description":"A attribute which will always hold the first value(initial name) of Yodlee defined highLevelCategoryName attribute.

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"},"detailCategory":{"description":"Entity that provides detail category attributes

    Applicable containers: creditCard, investment, insurance, loan
    ","items":{"$ref":"#/components/schemas/DetailCategory"},"readOnly":true,"type":"array"},"highLevelCategoryId":{"description":"The unique identifier of the high level category.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"highLevelCategoryName":{"description":"The name of the high level category. A group of similar transaction categories are clubbed together to form a high-level category.

    Applicable containers: creditCard, investment, insurance, loan
    ","readOnly":true,"type":"string"},"id":{"description":"Unique identifier of the category.

    Applicable containers: creditCard, investment, insurance, loan
    ","format":"int64","readOnly":true,"type":"integer"},"source":{"description":"Source used to identify whether the transaction category is user defined category or system created category.

    Applicable containers: creditCard, investment, insurance, loan
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"type":{"description":"Transaction categories and high-level categories are further mapped to five transaction category types. Customers, based on their needs can either use the transaction categories, the high-level categories, or the transaction category types.

    Applicable containers: creditCard, investment, insurance, loan
    Applicable Values
    ","enum":["TRANSFER","DEFERRED_COMPENSATION","UNCATEGORIZE","INCOME","EXPENSE"],"readOnly":true,"type":"string"}},"title":"TransactionCategory","type":"object"},"TransactionCategoryRequest":{"properties":{"categoryName":{"maxLength":50,"minLength":1,"type":"string"},"parentCategoryId":{"exclusiveMinimum":false,"format":"int32","minimum":1,"type":"integer"},"source":{"readOnly":true,"type":"string"}},"required":["parentCategoryId"],"title":"TransactionCategoryRequest","type":"object"},"TransactionCategoryResponse":{"properties":{"transactionCategory":{"items":{"$ref":"#/components/schemas/TransactionCategory"},"readOnly":true,"type":"array"}},"title":"TransactionCategoryResponse","type":"object"},"TransactionCount":{"properties":{"TOTAL":{"$ref":"#/components/schemas/TransactionTotal"}},"title":"TransactionCount","type":"object"},"TransactionCountResponse":{"properties":{"transaction":{"$ref":"#/components/schemas/TransactionCount"}},"title":"TransactionCountResponse","type":"object"},"TransactionDays":{"properties":{"fullAccountNumberFields":{"items":{"enum":["paymentAccountNumber","unmaskedAccountNumber"],"type":"string"},"type":"array"},"numberOfTransactionDays":{"format":"int32","type":"integer"}},"title":"TransactionDays","type":"object"},"TransactionRequest":{"properties":{"transaction":{"$ref":"#/components/schemas/UpdateTransaction"}},"required":["transaction"],"title":"TransactionRequest","type":"object"},"TransactionResponse":{"properties":{"transaction":{"items":{"$ref":"#/components/schemas/Transaction"},"readOnly":true,"type":"array"}},"title":"TransactionResponse","type":"object"},"TransactionTotal":{"properties":{"count":{"format":"int64","type":"integer"}},"title":"TransactionTotal","type":"object"},"UpdateAccountInfo":{"properties":{"accountName":{"maxLength":100,"minLength":1,"type":"string"},"accountNumber":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9]+$","type":"string"},"accountStatus":{"enum":["ACTIVE","INACTIVE","TO_BE_CLOSED","CLOSED","DELETED"],"type":"string"},"address":{"$ref":"#/components/schemas/AccountAddress"},"amountDue":{"$ref":"#/components/schemas/Money"},"balance":{"$ref":"#/components/schemas/Money"},"container":{"enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"type":"string"},"dueDate":{"type":"string"},"frequency":{"enum":["DAILY","ONE_TIME","WEEKLY","EVERY_2_WEEKS","SEMI_MONTHLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","EVERY_2_MONTHS","EBILL","FIRST_DAY_MONTHLY","LAST_DAY_MONTHLY","EVERY_4_WEEKS","UNKNOWN","OTHER"],"type":"string"},"homeValue":{"$ref":"#/components/schemas/Money"},"includeInNetWorth":{"type":"string"},"isEbillEnrolled":{"type":"string"},"memo":{"maxLength":250,"minLength":0,"type":"string"},"nickname":{"maxLength":50,"minLength":0,"type":"string"}},"title":"UpdateAccountInfo","type":"object"},"UpdateAccountRequest":{"properties":{"account":{"$ref":"#/components/schemas/UpdateAccountInfo"}},"required":["account"],"title":"UpdateAccountRequest","type":"object"},"UpdateCategoryRequest":{"properties":{"categoryName":{"type":"string"},"highLevelCategoryName":{"type":"string"},"id":{"exclusiveMinimum":false,"format":"int64","minimum":1,"type":"integer"},"source":{"enum":["SYSTEM","USER"],"type":"string"}},"required":["id","source"],"title":"UpdateCategoryRequest","type":"object"},"UpdateCobrandNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET cobrand/config/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"UpdateCobrandNotificationEvent","type":"object"},"UpdateCobrandNotificationEventRequest":{"properties":{"event":{"$ref":"#/components/schemas/UpdateCobrandNotificationEvent"}},"required":["event"],"title":"UpdateCobrandNotificationEventRequest","type":"object"},"UpdateConfigsNotificationEvent":{"properties":{"callbackUrl":{"description":"URL to which the notification should be posted.

    Endpoints:
    • GET configs/notifications/events
    ","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"UpdateConfigsNotificationEvent","type":"object"},"UpdateConfigsNotificationEventRequest":{"properties":{"event":{"$ref":"#/components/schemas/UpdateConfigsNotificationEvent"}},"required":["event"],"title":"UpdateConfigsNotificationEventRequest","type":"object"},"UpdateTransaction":{"properties":{"categoryId":{"format":"int64","type":"integer"},"categorySource":{"enum":["SYSTEM","USER"],"type":"string"},"container":{"enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"type":"string"},"description":{"$ref":"#/components/schemas/Description"},"memo":{"type":"string"}},"required":["categoryId","categorySource","container"],"title":"UpdateTransaction","type":"object"},"UpdateUserRegistration":{"properties":{"address":{"$ref":"#/components/schemas/UserAddress"},"email":{"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"preferences":{"$ref":"#/components/schemas/UserRequestPreferences"},"segmentName":{"type":"string"}},"title":"UpdateUserRegistration","type":"object"},"UpdateUserRequest":{"properties":{"user":{"$ref":"#/components/schemas/UpdateUserRegistration"}},"required":["user"],"title":"UpdateUserRequest","type":"object"},"UpdateVerification":{"properties":{"account":{"$ref":"#/components/schemas/VerificationAccount"},"accountId":{"description":"Unique identifier for the account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"providerAccountId":{"description":"Unique identifier for the provider account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"reason":{"description":"The reason the account verification failed.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","enum":["DATA_NOT_AVAILABLE","ACCOUNT_HOLDER_MISMATCH","FULL_ACCOUNT_NUMBER_AND_BANK_TRANSFER_CODE_NOT_AVAILABLE","FULL_ACCOUNT_NUMBER_NOT_AVAILABLE","BANK_TRANSFER_CODE_NOT_AVAILABLE","EXPIRED","DATA_MISMATCH","INSTRUCTION_GENERATION_ERROR"],"readOnly":true,"type":"string"},"transaction":{"items":{"$ref":"#/components/schemas/VerificationTransaction"},"type":"array"},"verificationDate":{"description":"The date of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","readOnly":true,"type":"string"},"verificationId":{"description":"Unique identifier for the verification request.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","readOnly":true,"type":"integer"},"verificationStatus":{"description":"The status of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["INITIATED","DEPOSITED","SUCCESS","FAILED"],"readOnly":true,"type":"string"},"verificationType":{"description":"The account verification type.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["MATCHING","CHALLENGE_DEPOSIT"],"type":"string"}},"required":["transaction"],"title":"UpdateVerification","type":"object"},"UpdateVerificationRequest":{"properties":{"verification":{"$ref":"#/components/schemas/UpdateVerification"}},"title":"UpdateVerificationRequest","type":"object"},"UpdatedProviderAccount":{"properties":{"aggregationSource":{"description":"The source through which the providerAccount is added in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["SYSTEM","USER"],"readOnly":true,"type":"string"},"createdDate":{"description":"The date on when the provider account is created in the system.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"dataset":{"description":"Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","items":{"$ref":"#/components/schemas/AccountDataset"},"readOnly":true,"type":"array"},"id":{"description":"Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"isManual":{"description":"Indicates whether account is a manual or aggregated provider account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","readOnly":true,"type":"boolean"},"lastUpdated":{"description":"Indicate when the providerAccount is last updated successfully.

    Account Type: Aggregated
    Endpoints:
    • GET dataExtracts/userData
    ","readOnly":true,"type":"string"},"loginForm":{"description":"This entity gets returned in the response for only MFA based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of MFA form that is displayed to the user in the provider site.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","items":{"$ref":"#/components/schemas/LoginForm"},"readOnly":true,"type":"array"},"oauthMigrationStatus":{"description":"Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider.

    Endpoints:
    • GET providerAccounts
    • GET providerAccounts/{providerAccountId}
    • PUT providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","enum":["IN_PROGRESS","TO_BE_MIGRATED","COMPLETED"],"readOnly":true,"type":"string"},"providerId":{"description":"Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    ","format":"int64","readOnly":true,"type":"integer"},"requestId":{"description":"Unique id generated to indicate the request.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    ","readOnly":true,"type":"string"},"status":{"description":"The status of last update attempted for the account.

    Endpoints:
    • GET providerAccounts
    • POST providerAccounts
    • PUT providerAccounts/{providerAccountId}
    • GET providerAccounts/{providerAccountId}
    • GET dataExtracts/userData
    Applicable Values
    ","enum":["LOGIN_IN_PROGRESS","USER_INPUT_REQUIRED","IN_PROGRESS","PARTIAL_SUCCESS","SUCCESS","FAILED","MIGRATION_IN_PROGRESS"],"readOnly":true,"type":"string"}},"title":"UpdatedProviderAccount","type":"object"},"UpdatedProviderAccountResponse":{"properties":{"providerAccount":{"items":{"$ref":"#/components/schemas/UpdatedProviderAccount"},"readOnly":true,"type":"array"}},"title":"UpdatedProviderAccountResponse","type":"object"},"User":{"properties":{"id":{"description":"The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for.

    Endpoints:
    • POST user/samlLogin
    • POST user/register
    • GET user
    ","format":"int64","readOnly":true,"type":"integer"},"loginName":{"description":"The login name of the user used for authentication.

    Endpoints:
    • POST user/register
    • GET user
    ","readOnly":true,"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"preferences":{"$ref":"#/components/schemas/UserResponsePreferences"},"roleType":{"enum":["INDIVIDUAL"],"type":"string"},"session":{"$ref":"#/components/schemas/UserSession"}},"title":"User","type":"object"},"UserAccessToken":{"properties":{"accessTokens":{"items":{"$ref":"#/components/schemas/AccessTokens"},"type":"array"}},"title":"UserAccessToken","type":"object"},"UserAccessTokensResponse":{"properties":{"user":{"$ref":"#/components/schemas/UserAccessToken"}},"title":"UserAccessTokensResponse","type":"object"},"UserAddress":{"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"title":"UserAddress","type":"object"},"UserDetail":{"properties":{"address":{"$ref":"#/components/schemas/UserAddress"},"email":{"description":"The email address of the user.

    Endpoints:
    • GET user
    ","readOnly":true,"type":"string"},"id":{"description":"The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for.

    Endpoints:
    • POST user/samlLogin
    • POST user/register
    • GET user
    ","format":"int64","readOnly":true,"type":"integer"},"loginName":{"description":"The login name of the user used for authentication.

    Endpoints:
    • POST user/register
    • GET user
    ","readOnly":true,"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"preferences":{"$ref":"#/components/schemas/UserResponsePreferences"},"roleType":{"enum":["INDIVIDUAL"],"type":"string"},"segmentName":{"type":"string"}},"title":"UserDetail","type":"object"},"UserDetailResponse":{"properties":{"user":{"$ref":"#/components/schemas/UserDetail"}},"title":"UserDetailResponse","type":"object"},"UserRegistration":{"properties":{"address":{"$ref":"#/components/schemas/UserAddress"},"email":{"type":"string"},"loginName":{"maxLength":150,"minLength":3,"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"preferences":{"$ref":"#/components/schemas/UserRequestPreferences"},"segmentName":{"type":"string"}},"required":["loginName"],"title":"UserRegistration","type":"object"},"UserRequest":{"properties":{"user":{"$ref":"#/components/schemas/UserRegistration"}},"required":["user"],"title":"UserRequest","type":"object"},"UserRequestPreferences":{"properties":{"currency":{"description":"The currency of the user. This currency will be respected while providing the response for derived API services.
    Applicable Values
    ","enum":["AUD","BRL","CAD","EUR","GBP","HKD","IDR","INR","JPY","NZD","SGD","USD","ZAR","CNY","VND","MYR","CHF"],"type":"string"},"dateFormat":{"description":"The dateformat of the user.This attribute is just a place holder and has no impact on any other API services.","maxLength":2147483647,"minLength":1,"type":"string"},"locale":{"description":"The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services.
    Applicable Values
    ","enum":["en_US","en_ES","fr_CA","zh_CN"],"type":"string"},"timeZone":{"description":"The timezone of the user. This attribute is just a place holder and has no impact on any other API services.","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"UserRequestPreferences","type":"object"},"UserResponse":{"properties":{"user":{"$ref":"#/components/schemas/User"}},"title":"UserResponse","type":"object"},"UserResponsePreferences":{"properties":{"currency":{"description":"The currency of the user. This currency will be respected while providing the response for derived API services.
    Applicable Values
    ","enum":["AUD","BRL","CAD","EUR","GBP","HKD","IDR","INR","JPY","NZD","SGD","USD","ZAR","CNY","VND","MYR","CHF"],"type":"string"},"dateFormat":{"description":"The dateformat of the user.This attribute is just a place holder and has no impact on any other API services.","maxLength":2147483647,"minLength":1,"type":"string"},"locale":{"description":"The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services.
    Applicable Values
    ","enum":["en_US","en_ES","fr_CA","zh_CN"],"type":"string"},"timeZone":{"description":"The timezone of the user. This attribute is just a place holder and has no impact on any other API services.","maxLength":2147483647,"minLength":1,"type":"string"}},"title":"UserResponsePreferences","type":"object"},"UserSession":{"properties":{"userSession":{"description":"Session provided for a valid user to access API services upon successful authentication.

    Endpoints:
    • POST user/samlLogin
    • POST user/register
    ","readOnly":true,"type":"string"}},"title":"UserSession","type":"object"},"Verification":{"properties":{"account":{"$ref":"#/components/schemas/VerificationAccount"},"accountId":{"description":"Unique identifier for the account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"providerAccountId":{"description":"Unique identifier for the provider account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"reason":{"description":"The reason the account verification failed.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","enum":["DATA_NOT_AVAILABLE","ACCOUNT_HOLDER_MISMATCH","FULL_ACCOUNT_NUMBER_AND_BANK_TRANSFER_CODE_NOT_AVAILABLE","FULL_ACCOUNT_NUMBER_NOT_AVAILABLE","BANK_TRANSFER_CODE_NOT_AVAILABLE","EXPIRED","DATA_MISMATCH","INSTRUCTION_GENERATION_ERROR"],"readOnly":true,"type":"string"},"verificationDate":{"description":"The date of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","readOnly":true,"type":"string"},"verificationId":{"description":"Unique identifier for the verification request.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","readOnly":true,"type":"integer"},"verificationStatus":{"description":"The status of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["INITIATED","DEPOSITED","SUCCESS","FAILED"],"readOnly":true,"type":"string"},"verificationType":{"description":"The account verification type.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["MATCHING","CHALLENGE_DEPOSIT"],"type":"string"}},"title":"Verification","type":"object"},"VerificationAccount":{"properties":{"accountName":{"type":"string"},"accountNumber":{"maxLength":17,"minLength":3,"type":"string"},"accountType":{"enum":["SAVINGS","CHECKING"],"type":"string"},"bankTransferCode":{"$ref":"#/components/schemas/VerificationBankTransferCode"}},"required":["accountNumber","accountType","bankTransferCode"],"title":"VerificationAccount","type":"object"},"VerificationBankTransferCode":{"properties":{"id":{"description":"The FI's branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom).
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST verification
    ","type":"string"},"type":{"description":"The bank transfer code type varies depending on the region of the account origination.
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST verification
    Applicable Values
    ","enum":["BSB","IFSC","ROUTING_NUMBER","SORT_CODE"],"type":"string"}},"title":"VerificationBankTransferCode","type":"object"},"VerificationRequest":{"properties":{"verification":{"$ref":"#/components/schemas/Verification"}},"required":["verification"],"title":"VerificationRequest","type":"object"},"VerificationResponse":{"properties":{"verification":{"items":{"$ref":"#/components/schemas/Verification"},"readOnly":true,"type":"array"}},"title":"VerificationResponse","type":"object"},"VerificationStatus":{"properties":{"account":{"$ref":"#/components/schemas/VerificationAccount"},"accountId":{"description":"Unique identifier for the account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"providerAccountId":{"description":"Unique identifier for the provider account.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","type":"integer"},"reason":{"description":"The reason the account verification failed.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","enum":["DATA_NOT_AVAILABLE","ACCOUNT_HOLDER_MISMATCH","FULL_ACCOUNT_NUMBER_AND_BANK_TRANSFER_CODE_NOT_AVAILABLE","FULL_ACCOUNT_NUMBER_NOT_AVAILABLE","BANK_TRANSFER_CODE_NOT_AVAILABLE","EXPIRED","DATA_MISMATCH","INSTRUCTION_GENERATION_ERROR"],"readOnly":true,"type":"string"},"remainingAttempts":{"format":"int64","readOnly":true,"type":"integer"},"verificationDate":{"description":"The date of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","readOnly":true,"type":"string"},"verificationId":{"description":"Unique identifier for the verification request.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification
    ","format":"int64","readOnly":true,"type":"integer"},"verificationStatus":{"description":"The status of the account verification.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["INITIATED","DEPOSITED","SUCCESS","FAILED"],"readOnly":true,"type":"string"},"verificationType":{"description":"The account verification type.

    Endpoints:
    • POST verification
    • GET verification
    • PUT verification

    Applicable Values","enum":["MATCHING","CHALLENGE_DEPOSIT"],"type":"string"}},"title":"VerificationStatus","type":"object"},"VerificationStatusResponse":{"properties":{"verification":{"items":{"$ref":"#/components/schemas/VerificationStatus"},"readOnly":true,"type":"array"}},"title":"VerificationStatusResponse","type":"object"},"VerificationTransaction":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"baseType":{"enum":["CREDIT","DEBIT"],"type":"string"}},"required":["amount","baseType"],"title":"VerificationTransaction","type":"object"},"VerifiedAccount":{"properties":{"accountNumber":{"description":"The account number as it appears on the site. (The POST accounts service response return this field as number)
    Additional Details: Bank/ Loan/ Insurance/ Investment:
    The account number for the bank account as it appears at the site.
    Credit Card: The account number of the card account as it appears at the site,
    i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    • GET accounts
    • GET accounts/{accountId}
    • POST accounts
    ","readOnly":true,"type":"string"},"accountType":{"description":"The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account.
    Valid Values:
    Aggregated Account Type
    bank
    • CHECKING
    • SAVINGS
    • CD
    • PPF
    • RECURRING_DEPOSIT
    • FSA
    • MONEY_MARKET
    • IRA
    • PREPAID
    creditCard
    • OTHER
    • CREDIT
    • STORE
    • CHARGE
    • OTHER
    investment (SN 1.0)
    • BROKERAGE_MARGIN
    • HSA
    • IRA
    • BROKERAGE_CASH
    • 401K
    • 403B
    • TRUST
    • ANNUITY
    • SIMPLE
    • CUSTODIAL
    • BROKERAGE_CASH_OPTION
    • BROKERAGE_MARGIN_OPTION
    • INDIVIDUAL
    • CORPORATE
    • JTTIC
    • JTWROS
    • COMMUNITY_PROPERTY
    • JOINT_BY_ENTIRETY
    • CONSERVATORSHIP
    • ROTH
    • ROTH_CONVERSION
    • ROLLOVER
    • EDUCATIONAL
    • 529_PLAN
    • 457_DEFERRED_COMPENSATION
    • 401A
    • PSP
    • MPP
    • STOCK_BASKET
    • LIVING_TRUST
    • REVOCABLE_TRUST
    • IRREVOCABLE_TRUST
    • CHARITABLE_REMAINDER
    • CHARITABLE_LEAD
    • CHARITABLE_GIFT_ACCOUNT
    • SEP
    • UTMA
    • UGMA
    • ESOPP
    • ADMINISTRATOR
    • EXECUTOR
    • PARTNERSHIP
    • SOLE_PROPRIETORSHIP
    • CHURCH
    • INVESTMENT_CLUB
    • RESTRICTED_STOCK_AWARD
    • CMA
    • EMPLOYEE_STOCK_PURCHASE_PLAN
    • PERFORMANCE_PLAN
    • BROKERAGE_LINK_ACCOUNT
    • MONEY_MARKET
    • SUPER_ANNUATION
    • REGISTERED_RETIREMENT_SAVINGS_PLAN
    • SPOUSAL_RETIREMENT_SAVINGS_PLAN
    • DEFERRED_PROFIT_SHARING_PLAN
    • NON_REGISTERED_SAVINGS_PLAN
    • REGISTERED_EDUCATION_SAVINGS_PLAN
    • GROUP_RETIREMENT_SAVINGS_PLAN
    • LOCKED_IN_RETIREMENT_SAVINGS_PLAN
    • RESTRICTED_LOCKED_IN_SAVINGS_PLAN
    • LOCKED_IN_RETIREMENT_ACCOUNT
    • REGISTERED_PENSION_PLAN
    • TAX_FREE_SAVINGS_ACCOUNT
    • LIFE_INCOME_FUND
    • REGISTERED_RETIREMENT_INCOME_FUND
    • SPOUSAL_RETIREMENT_INCOME_FUND
    • LOCKED_IN_REGISTERED_INVESTMENT_FUND
    • PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND
    • GUARANTEED_INVESTMENT_CERTIFICATES
    • REGISTERED_DISABILITY_SAVINGS_PLAN
    • OTHER
    investment (SN 2.0)
    • BROKERAGE_CASH
    • BROKERAGE_MARGIN
    • INDIVIDUAL_RETIREMENT_ACCOUNT_IRA
    • EMPLOYEE_RETIREMENT_ACCOUNT_401K
    • EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B
    • TRUST
    • ANNUITY
    • SIMPLE_IRA
    • CUSTODIAL_ACCOUNT
    • BROKERAGE_CASH_OPTION
    • BROKERAGE_MARGIN_OPTION
    • INDIVIDUAL
    • CORPORATE_INVESTMENT_ACCOUNT
    • JOINT_TENANTS_TENANCY_IN_COMMON_JTIC
    • JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS
    • JOINT_TENANTS_COMMUNITY_PROPERTY
    • JOINT_TENANTS_TENANTS_BY_ENTIRETY
    • CONSERVATOR
    • ROTH_IRA
    • ROTH_CONVERSION
    • ROLLOVER_IRA
    • EDUCATIONAL
    • EDUCATIONAL_SAVINGS_PLAN_529
    • DEFERRED_COMPENSATION_PLAN_457
    • MONEY_PURCHASE_RETIREMENT_PLAN_401A
    • PROFIT_SHARING_PLAN
    • MONEY_PURCHASE_PLAN
    • STOCK_BASKET_ACCOUNT
    • LIVING_TRUST
    • REVOCABLE_TRUST
    • IRREVOCABLE_TRUST
    • CHARITABLE_REMAINDER_TRUST
    • CHARITABLE_LEAD_TRUST
    • CHARITABLE_GIFT_ACCOUNT
    • SEP_IRA
    • UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA
    • UNIFORM_GIFT_TO_MINORS_ACT_UGMA
    • EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP
    • ADMINISTRATOR
    • EXECUTOR
    • PARTNERSHIP
    • PROPRIETORSHIP
    • CHURCH_ACCOUNT
    • INVESTMENT_CLUB
    • RESTRICTED_STOCK_AWARD
    • CASH_MANAGEMENT_ACCOUNT
    • EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP
    • PERFORMANCE_PLAN
    • BROKERAGE_LINK_ACCOUNT
    • MONEY_MARKET_ACCOUNT
    • SUPERANNUATION
    • REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP
    • SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP
    • DEFERRED_PROFIT_SHARING_PLAN_DPSP
    • NON_REGISTERED_SAVINGS_PLAN_NRSP
    • REGISTERED_EDUCATION_SAVINGS_PLAN_RESP
    • GROUP_RETIREMENT_SAVINGS_PLAN_GRSP
    • LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP
    • RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP
    • LOCKED_IN_RETIREMENT_ACCOUNT_LIRA
    • REGISTERED_PENSION_PLAN_RPP
    • TAX_FREE_SAVINGS_ACCOUNT_TFSA
    • LIFE_INCOME_FUND_LIF
    • REGISTERED_RETIREMENT_INCOME_FUND_RIF
    • SPOUSAL_RETIREMENT_INCOME_FUND_SRIF
    • LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF
    • PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF
    • GUARANTEED_INVESTMENT_CERTIFICATES_GIC
    • REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP
    • DEFINED_CONTRIBUTION_PLAN
    • DEFINED_BENEFIT_PLAN
    • EMPLOYEE_STOCK_OPTION_PLAN
    • NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A
    • KEOGH_PLAN
    • EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K
    • DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP
    • EMPLOYEE_BENEFIT_PLAN
    • EMPLOYEE_SAVINGS_PLAN
    • HEALTH_SAVINGS_ACCOUNT_HSA
    • COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA
    • TESTAMENTARY_TRUST
    • ESTATE
    • GRANTOR_RETAINED_ANNUITY_TRUST_GRAT
    • ADVISORY_ACCOUNT
    • NON_PROFIT_ORGANIZATION_501C
    • HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA
    • INDIVIDUAL_SAVINGS_ACCOUNT_ISA
    • CASH_ISA
    • STOCKS_AND_SHARES_ISA
    • INNOVATIVE_FINANCE_ISA
    • JUNIOR_ISA
    • EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO
    • PUBLIC_PROVIDENT_FUND_PPF
    • EMPLOYEES_PENSION_SCHEME_EPS
    • NATIONAL_PENSION_SYSTEM_NPS
    • INDEXED_ANNUITY
    • ANNUITIZED_ANNUITY
    • VARIABLE_ANNUITY
    • ROTH_403B
    • SPOUSAL_IRA
    • SPOUSAL_ROTH_IRA
    • SARSEP_IRA
    • SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP
    • OFFSHORE_TRUST
    • IRREVOCABLE_LIFE_INSURANCE_TRUST
    • INTERNATIONAL_TRUST
    • LIFE_INTEREST_TRUST
    • EMPLOYEE_BENEFIT_TRUST
    • PRECIOUS_METAL_ACCOUNT
    • INVESTMENT_LOAN_ACCOUNT
    • GRANTOR_RETAINED_INCOME_TRUST
    • PENSION_PLAN
    • OTHER
    loan
    • MORTGAGE
    • INSTALLMENT_LOAN
    • PERSONAL_LOAN
    • HOME_EQUITY_LINE_OF_CREDIT
    • LINE_OF_CREDIT
    • AUTO_LOAN
    • STUDENT_LOAN
    • HOME_LOAN
    insurance
    • AUTO_INSURANCE
    • HEALTH_INSURANCE
    • HOME_INSURANCE
    • LIFE_INSURANCE
    • ANNUITY
    • TRAVEL_INSURANCE
    • INSURANCE
    realEstate
    • REAL_ESTATE
    reward
    • REWARD_POINTS
    Manual Account Type
    bank
    • CHECKING
    • SAVINGS
    • CD
    • PREPAID
    credit
    • CREDIT
    loan
    • PERSONAL_LOAN
    • HOME_LOAN
    insurance
    • INSURANCE
    • ANNUITY
    investment
    • BROKERAGE_CASH


    Aggregated / Manual: Both
    Applicable containers: All containers
    ","readOnly":true,"type":"string"},"bankTransferCode":{"description":"Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
      ","items":{"$ref":"#/components/schemas/BankTransferCode"},"readOnly":true,"type":"array"},"fullAccountNumber":{"type":"string"},"holder":{"items":{"$ref":"#/components/schemas/AccountHolder"},"type":"array"},"id":{"format":"int64","type":"integer"},"providerAccountId":{"description":"The primary key of the provider account resource.

      Aggregated / Manual: Both
      Applicable containers: All containers
      ","format":"int64","readOnly":true,"type":"integer"},"providerName":{"description":"Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
      ","readOnly":true,"type":"string"}},"title":"VerifiedAccount","type":"object"},"VerifyAccount":{"properties":{"account":{"items":{"$ref":"#/components/schemas/VerifiedAccount"},"type":"array"},"transactionCriteria":{"items":{"$ref":"#/components/schemas/VerifyTransactionCriteria"},"type":"array"}},"title":"VerifyAccount","type":"object"},"VerifyAccountRequest":{"properties":{"accountId":{"format":"int64","type":"integer"},"container":{"enum":["bank","creditCard","investment","insurance","loan","reward","realEstate","otherAssets","otherLiabilities"],"type":"string"},"transactionCriteria":{"items":{"$ref":"#/components/schemas/VerifyTransactionCriteria"},"type":"array"}},"required":["transactionCriteria"],"title":"VerifyAccountRequest","type":"object"},"VerifyAccountResponse":{"properties":{"verifyAccount":{"$ref":"#/components/schemas/VerifyAccount"}},"title":"VerifyAccountResponse","type":"object"},"VerifyTransactionCriteria":{"properties":{"amount":{"format":"double","type":"number"},"baseType":{"description":"Indicates if the transaction appears as a debit or a credit transaction in the account.

      Applicable containers: bank,creditCard,investment,insurance,loan
      Applicable Values
      ","enum":["CREDIT","DEBIT"],"type":"string"},"date":{"type":"string"},"dateVariance":{"type":"string"},"keyword":{"type":"string"},"matched":{"description":"Indicates if the criteria is matched or not.
      Applicable Values
      ","enum":["COMPLETE","NONE"],"readOnly":true,"type":"string"},"verifiedTransaction":{"items":{"$ref":"#/components/schemas/Transaction"},"readOnly":true,"type":"array"}},"required":["amount","date"],"title":"VerifyTransactionCriteria","type":"object"},"YodleeError":{"properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"referenceCode":{"type":"string"}},"title":"YodleeError","type":"object"}}}}