openapi: 3.0.1 info: title: Envestnet Aggregation APIs Account Token Accounts API description: 'This file describes the Yodlee Aggregation product APIs using the swagger notation that you can use to build your financial application. You can generate the client SDK in Python, JavaScript, PHP, or any other languages according to your development needs. For more details about the APIs, refer to Yodlee API v1.1 - Overview.

You will have to set the header before making the API call. The following headers apply to all the APIs:Note: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.' termsOfService: https://developer.yodlee.com/terms/condition contact: email: developer@yodlee.com license: name: Yodlee Developer License url: https://developer.yodlee.com/terms/condition#_Services_1 version: 1.1.0 servers: - url: / tags: - name: Accounts description: Accounts API paths: /accounts/evaluateAddress: post: tags: - Accounts summary: Envestnet Evaluate Address 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: operationId: evaluateAddress requestBody: description: addressParam content: application/json: schema: $ref: '#/components/schemas/EvaluateAddressRequest' required: true responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EvaluateAddressResponse' 400: 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' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /accounts/{accountId}: get: tags: - Accounts summary: Envestnet Get Account Details 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: - name: accountId in: path description: accountId required: true schema: type: integer format: int64 - name: convertToCurrency in: query description: On-demand currency conversion parameter allowEmptyValue: false schema: type: string - name: include in: query description: profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh
    Note:fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response. allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AccountResponse' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false put: tags: - Accounts summary: Envestnet Update Account 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.
  • A real estate account can be linked to a loan account by passing accountId of a loan account in linkedAccountIds .
  • Attribute isEbillEnrolled is deprecated as it is applicable for bill accounts only.
    • operationId: updateAccount parameters: - name: accountId in: path description: accountId required: true schema: type: integer format: int64 requestBody: description: accountRequest content: application/json: schema: $ref: '#/components/schemas/UpdateAccountRequest' required: true responses: 204: description: OK content: {} 400: 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
    ' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false delete: tags: - Accounts summary: Envestnet Delete Account 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: - name: accountId in: path description: accountId required: true schema: type: integer format: int64 responses: 204: description: OK content: {} 400: description: 'Y800 : Invalid value for accountId
    Y806 : Invalid input
    Y807 : Resource not found
    Y868 : No action is allowed, as the data is being migrated to the Open Banking provider
    ' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /accounts/historicalBalances: get: tags: - Accounts summary: Envestnet Get Historical Balances 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.
    By default, pagination is available for the historicalBalances entity in this API. 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 historical balances.
    The API will only retrieve a maximum 500 records by default when values for skip and top parameters are not provided. operationId: getHistoricalBalances parameters: - name: accountId in: query description: accountId allowEmptyValue: false schema: type: string - name: fromDate in: query description: from date for balance retrieval (YYYY-MM-DD) allowEmptyValue: false schema: type: string - name: includeCF in: query description: Consider carry forward logic for missing balances allowEmptyValue: false schema: type: boolean - name: interval in: query description: D-daily, W-weekly or M-monthly allowEmptyValue: false schema: type: string - name: skip in: query description: skip (Min 0) allowEmptyValue: false schema: type: integer format: int32 - name: toDate in: query description: toDate for balance retrieval (YYYY-MM-DD) allowEmptyValue: false schema: type: string - name: top in: query description: top (Max 500) allowEmptyValue: false schema: type: integer format: int32 responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AccountHistoricalBalancesResponse' 400: 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' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /accounts: get: tags: - Accounts summary: Envestnet Get Accounts description: This API Reference guide is intended for FastLink 4 Users. For FastLink 3 Users, there are additional integration notes related to this endpoint here.

    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.

    This API returns all the accounts that were chosen by the user in both the verification selection screen and the aggregation selection screen. In FastLink 4, we have separate APIs to provide the data for verification product-related data (/verification/verifiedAccounts) and the GET accounts should be utilized with an additional query param (isSelectedForAggregation=true) to retrieve only the aggregation accounts. operationId: getAllAccounts parameters: - name: accountId in: query description: Comma separated accountIds. allowEmptyValue: false schema: type: string - name: container in: query description: bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities allowEmptyValue: false schema: type: string - name: convertToCurrency in: query description: On-demand currency conversion parameter allowEmptyValue: false schema: type: string - name: include in: query description: profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh
    Note:
  • fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

  • profile is deprecated, and to retrieve the profile information, call the GET /verification/holderProfile API instead.
    • allowEmptyValue: false schema: type: string - name: providerAccountId in: query description: Comma separated providerAccountIds. allowEmptyValue: false schema: type: string - name: requestId in: query description: The unique identifier that returns contextual data allowEmptyValue: false schema: type: string - name: status in: query description: ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AccountResponse' 400: 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' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false post: tags: - Accounts summary: Envestnet Add Manual Account 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: operationId: createManualAccount requestBody: description: accountParam content: application/json: schema: $ref: '#/components/schemas/CreateAccountRequest' required: true responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreatedAccountResponse' 400: 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
    ' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /accounts/latestBalances: get: tags: - Accounts summary: Envestnet Get Latest Balances description: The latest balances service provides the latest account balance by initiating a new balance refresh request operationId: getLatestBalances parameters: - name: accountId in: query description: Comma separated accountIds. required: true allowEmptyValue: false schema: type: string - name: providerAccountId in: query description: providerAccountId. required: true allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AccountBalanceResponse' 400: description: 'Y800 : Invalid value for providerAccountId
    Y800 : Invalid value for accountId
    Y800 : Invalid value for accountId. Only ACTIVE accountId are supported
    Y901 : Service not supported
    Y803 : providerAccountId required
    Y805 : Multiple providerAccountId not supported
    Y803 : accountId required
    Y820 : The accountId is not supported for container other than bank, investment
    Y824 : The maximum number of accountIds permitted is 10
    Y800 : Invalid value for accountId. All accountIds should belong to the same providerAccountId' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false components: schemas: UpdateAccountInfo: title: UpdateAccountInfo type: object properties: container: type: string enum: - bank - creditCard - investment - insurance - loan - reward - bill - realEstate - otherAssets - otherLiabilities includeInNetWorth: type: string address: $ref: '#/components/schemas/AccountAddress' accountName: maxLength: 100 minLength: 1 type: string dueDate: type: string memo: maxLength: 250 minLength: 0 type: string homeValue: $ref: '#/components/schemas/Money' accountNumber: maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9]+$ type: string frequency: type: string 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 accountStatus: type: string enum: - ACTIVE - INACTIVE - TO_BE_CLOSED - CLOSED - DELETED amountDue: $ref: '#/components/schemas/Money' linkedAccountIds: type: array description: List of loan accounts to which a real-estate account is linked. items: type: integer format: int64 balance: $ref: '#/components/schemas/Money' isEbillEnrolled: type: string nickname: maxLength: 50 minLength: 0 type: string EvaluateAddressRequest: title: EvaluateAddressRequest required: - address type: object properties: address: $ref: '#/components/schemas/EvaluateAccountAddress' CreatedAccountInfo: title: CreatedAccountInfo type: object properties: accountName: type: string readOnly: true id: type: integer format: int64 readOnly: true accountNumber: type: string readOnly: true PaymentProfile: title: PaymentProfile type: object properties: identifier: $ref: '#/components/schemas/PaymentIdentifier' address: type: array 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:
    ' items: $ref: '#/components/schemas/AccountAddress' paymentBankTransferCode: $ref: '#/components/schemas/PaymentBankTransferCode' EvaluateAccountAddress: title: EvaluateAccountAddress required: - street type: object properties: zip: type: string description: Zip. country: type: string description: Country. address3: type: string description: Address Line 3. address2: type: string description: Address Line 2. city: type: string description: City. sourceType: type: string address1: type: string description: Address Line 1. street: type: string state: type: string description: State. type: type: string enum: - HOME - BUSINESS - POBOX - RETAIL - OFFICE - SMALL_BUSINESS - COMMUNICATION - PERMANENT - STATEMENT_ADDRESS - PAYMENT - PAYOFF - UNKNOWN PaymentIdentifier: title: PaymentIdentifier type: object properties: type: type: string description: Type of Identifier readOnly: true enum: - REFERENCE_NUMBER - PLATFORM_CODE value: type: string description: Value of the identifier readOnly: true YodleeError: title: YodleeError type: object properties: errorMessage: type: string description: The descriptive message that explains the error scenario. readOnly: true errorCode: type: string description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities. readOnly: true referenceCode: type: string description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end. readOnly: true AccountResponse: title: AccountResponse type: object properties: account: type: array readOnly: true items: $ref: '#/components/schemas/Account' AccountLatestBalance: title: AccountLatestBalance type: object properties: accountName: type: string description: 'The account name as it appears at the site.
    (The POST accounts service response return this field as name)
    Applicable containers: bank, investment
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true totalBalance: $ref: '#/components/schemas/Money' accountType: type: string description: The type of account that is aggregated, i.e., savings, checking, charge, HELOC, etc. The account type is derived based on the attributes of the account.
    Valid Values:
    Aggregated Account Type
    bankinvestment (SN 1.0)investment (SN 2.0) readOnly: true currentBalance: $ref: '#/components/schemas/Money' refreshStatus: type: string description: The status of the account balance refresh request. readOnly: true enum: - SUCCESS - IN_PROGRESS - FAILED accountNumber: type: string description: 'The account number as it appears on the site. (The POST accounts service response return this field as number)
    Additional Details: Bank / Investment:
    The account number for the bank account as it appears at 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: bank, investment
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true availableBalance: $ref: '#/components/schemas/Money' accountId: type: integer description: 'The primary key of the provider account resource.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:' format: int64 readOnly: true lastUpdated: type: string description: 'The date time the account information was last retrieved from the provider site and updated in the Yodlee system.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:' readOnly: true balance: $ref: '#/components/schemas/Money' providerId: type: string description: 'Identifier of the provider site. The primary key of provider resource.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:' readOnly: true providerAccountId: type: integer description: 'The primary key of the provider account resource.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:' format: int64 readOnly: true CONTAINER: type: string description: 'The type of service. E.g., Bank, Investment

    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:Applicable Values
    ' readOnly: true enum: - bank - investment cash: $ref: '#/components/schemas/Money' providerName: type: string description: 'Service provider or institution name where the account originates. This belongs to the provider resource.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment
    Endpoints:' readOnly: true failedReason: type: string description: The reason the account balance refresh failed. readOnly: true enum: - REQUIRED_DATA_NOT_AVAILABLE - USER_INPUT_REQUIRED - CREDENTIALS_UPDATE_NEEDED - INCORRECT_CREDENTIALS - USER_ACTION_NEEDED_AT_SITE - ADDL_AUTHENTICATION_REQUIRED - INVALID_ADDL_INFO_PROVIDED - ACCOUNT_LOCKED - SITE_NOT_SUPPORTED - SITE_BLOCKING_ERROR - TECH_ERROR - UNEXPECTED_SITE_ERROR - SITE_UNAVAILABLE - SITE_SESSION_INVALIDATED - REQUEST_TIME_OUT - CONSENT_EXPIRED - CONSENT_REVOKED - INCORRECT_OAUTH_TOKEN - CONSENT_REQUIRED - NEW_AUTHENTICATION_REQUIRED BankTransferCode: title: BankTransferCode type: object properties: id: type: string 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:
    ' type: type: string description: 'The bank transfer code type varies depending on the region of the account origination.
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    Applicable Values
    ' enum: - BSB - IFSC - ROUTING_NUMBER - SORT_CODE Account: title: Account type: object properties: availableCash: $ref: '#/components/schemas/Money' includeInNetWorth: type: boolean 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:' readOnly: true moneyMarketBalance: $ref: '#/components/schemas/Money' enrollmentDate: type: string description: 'Date on which the user is enrolled on the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true estimatedDate: type: string description: 'The date on which the home value was estimated.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:' readOnly: true memo: type: string description: 'The additional description or notes given by the user.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true guarantor: type: string 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:' readOnly: true interestPaidLastYear: $ref: '#/components/schemas/Money' lastUpdated: type: string 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:' readOnly: true balance: $ref: '#/components/schemas/Money' homeInsuranceType: type: string description: 'Type of home insurance, like -Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - HOME_OWNER - RENTAL - RENTER - UNKNOWN - OTHER id: type: integer description: 'The primary key of the account resource and the unique identifier for the account.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' format: int64 readOnly: true cash: $ref: '#/components/schemas/Money' totalCreditLine: $ref: '#/components/schemas/Money' providerName: type: string description: 'Service provider or institution name where the account originates. This belongs to the provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true valuationType: type: string description: 'The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:Applicable Values
    ' readOnly: true enum: - SYSTEM - MANUAL marginBalance: $ref: '#/components/schemas/Money' apr: type: number 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:
    ' format: double readOnly: true availableCredit: $ref: '#/components/schemas/Money' currentBalance: $ref: '#/components/schemas/Money' isManual: type: boolean 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:' readOnly: true profile: $ref: '#/components/schemas/AccountProfile' escrowBalance: $ref: '#/components/schemas/Money' nextLevel: type: string description: 'The eligible next level of the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true classification: type: string description: 'The classification of the account such as personal, corporate, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, reward, loan, insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - OTHER - PERSONAL - CORPORATE - SMALL_BUSINESS - TRUST - ADD_ON_CARD - VIRTUAL_CARD loanPayoffAmount: $ref: '#/components/schemas/Money' interestRateType: type: string description: 'The type of the interest rate, for example, fixed or variable.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    Applicable Values
    ' readOnly: true enum: - FIXED - VARIABLE - UNKNOWN - OTHER loanPayByDate: type: string description: 'The date by which the payoff amount should be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true faceAmount: $ref: '#/components/schemas/Money' policyFromDate: type: string description: 'The date the insurance policy began.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ' readOnly: true premiumPaymentTerm: type: string description: 'The number of years for which premium payments have to be made in a policy.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:' readOnly: true policyTerm: type: string 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:
    ' readOnly: true repaymentPlanType: type: string description: 'The type of repayment plan that the borrower prefers to repay the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:Applicable Values:
    ' readOnly: true enum: - STANDARD - GRADUATED - EXTENDED - INCOME_BASED - INCOME_CONTINGENT - INCOME_SENSITIVE - PAY_AS_YOU_EARN - REVISED_PAY_AS_YOU_EARN aggregatedAccountType: type: string description: The type of account that is aggregated. readOnly: true availableBalance: $ref: '#/components/schemas/Money' accountStatus: type: string 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:Applicable Values
    ' readOnly: true enum: - ACTIVE - INACTIVE - TO_BE_CLOSED - CLOSED - DELETED lifeInsuranceType: type: string description: 'Type of life insurance.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - OTHER - TERM_LIFE_INSURANCE - UNIVERSAL_LIFE_INSURANCE - WHOLE_LIFE_INSURANCE - VARIABLE_LIFE_INSURANCE - ULIP - ENDOWMENT fullAccountNumber: type: string 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:' readOnly: true premium: $ref: '#/components/schemas/Money' aggregationSource: type: string 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:
    Applicable Values
    ' readOnly: true enum: - SYSTEM - USER overDraftLimit: $ref: '#/components/schemas/Money' nickname: type: string 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:' readOnly: true term: type: string 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:' readOnly: true interestRate: type: number 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:' format: double readOnly: true deathBenefit: $ref: '#/components/schemas/Money' address: $ref: '#/components/schemas/AccountAddress' cashValue: $ref: '#/components/schemas/Money' holder: type: array description: 'Holder details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/AccountHolder' 401kLoan: $ref: '#/components/schemas/Money' homeValue: $ref: '#/components/schemas/Money' accountNumber: type: string 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:
    ' readOnly: true createdDate: type: string 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:' readOnly: true interestPaidYTD: $ref: '#/components/schemas/Money' providerAccountId: type: integer description: 'The primary key of the provider account resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' format: int64 readOnly: true collateral: type: string description: 'Property or possession offered to support a loan that can be seized on a default.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true dataset: type: array 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:' readOnly: true items: $ref: '#/components/schemas/AccountDataset' runningBalance: $ref: '#/components/schemas/Money' sourceId: type: string 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:' readOnly: true dueDate: type: string 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:' readOnly: true frequency: type: string 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:Applicable Values
    ' readOnly: true 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 maturityAmount: $ref: '#/components/schemas/Money' associatedProviderAccountId: type: array 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:' readOnly: true items: type: integer format: int64 isAsset: type: boolean description: 'The account to be considered as an asset or liability.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true principalBalance: $ref: '#/components/schemas/Money' totalCashLimit: $ref: '#/components/schemas/Money' maturityDate: type: string 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:' readOnly: true minimumAmountDue: $ref: '#/components/schemas/Money' annualPercentageYield: type: number 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:
    ' format: double readOnly: true accountType: type: string 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
    bankcreditCardinvestment (SN 1.0)investment (SN 2.0)loaninsurancerealEstaterewardManual Account Type
    bankcreditloaninsuranceinvestment

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true originationDate: type: string description: 'The date on which the loan is disbursed.

    Aggregated / Manual: Both
    Applicable containers: loan
    Endpoints:' readOnly: true totalVestedBalance: $ref: '#/components/schemas/Money' rewardBalance: type: array description: 'Information of different reward balances associated with the account.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/RewardBalance' sourceAccountStatus: type: string description: 'Indicates the status of the loan account.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:Applicable Values:
    ' readOnly: true enum: - IN_REPAYMENT - DEFAULTED - IN_SCHOOL - IN_GRACE_PERIOD - DELINQUENCY - DEFERMENT - FORBEARANCE linkedAccountIds: type: array description: 'List of Loan accountId(s) to which the real-estate account is linked

    Aggregated / Manual: Both
    Applicable containers: realEstate
    Endpoints:' readOnly: true items: type: integer format: int64 derivedApr: type: number 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:
    ' format: double readOnly: true policyEffectiveDate: type: string description: 'The date on which the insurance policy coverage commences.
    Applicable containers: insurance
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true totalUnvestedBalance: $ref: '#/components/schemas/Money' annuityBalance: $ref: '#/components/schemas/Money' accountName: type: string 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:
    ' readOnly: true totalCreditLimit: $ref: '#/components/schemas/Money' policyStatus: type: string description: 'The status of the policy.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    Applicable Values
    ' readOnly: true enum: - ACTIVE - IN_ACTIVE - OTHER shortBalance: $ref: '#/components/schemas/Money' lender: type: string description: 'The financial institution that provides the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true lastEmployeeContributionAmount: $ref: '#/components/schemas/Money' providerId: type: string description: 'Identifier of the provider site. The primary key of provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true lastPaymentDate: type: string 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:' readOnly: true primaryRewardUnit: type: string description: 'Primary reward unit for this reward program. E.g. miles, points, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true lastPaymentAmount: $ref: '#/components/schemas/Money' remainingBalance: $ref: '#/components/schemas/Money' userClassification: type: string description: 'Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
    Endpoints:
  • GET dataExtracts/userData
    • Applicable Values
    ' readOnly: true enum: - BUSINESS - PERSONAL bankTransferCode: type: array description: 'Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
    ' readOnly: true items: $ref: '#/components/schemas/BankTransferCode' expirationDate: type: string 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:' readOnly: true coverage: type: array description: 'The coverage-related details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/Coverage' cashApr: type: number description: 'Annual percentage rate applied to cash withdrawals on the card.

    Account Type: Aggregated
    Applicable containers: creditCard
    Endpoints:' format: double autoRefresh: $ref: '#/components/schemas/AutoRefresh' oauthMigrationStatus: type: string description: Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.

    Endpoints: readOnly: true enum: - IN_PROGRESS - TO_BE_MIGRATED - COMPLETED - MIGRATED displayedName: type: string 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:' readOnly: true fullAccountNumberList: $ref: '#/components/schemas/FullAccountNumberList' amountDue: $ref: '#/components/schemas/Money' currentLevel: type: string description: 'Current level of the reward program the user is associated with. E.g. Silver, Jade etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true originalLoanAmount: $ref: '#/components/schemas/Money' policyToDate: type: string description: 'The date to which the policy exists.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ' readOnly: true loanPayoffDetails: $ref: '#/components/schemas/LoanPayoffDetails' paymentProfile: $ref: '#/components/schemas/PaymentProfile' CONTAINER: type: string description: 'The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:Applicable Values
    ' readOnly: true enum: - bank - creditCard - investment - insurance - loan - reward - bill - realEstate - otherAssets - otherLiabilities lastEmployeeContributionDate: type: string 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:' readOnly: true lastPayment: $ref: '#/components/schemas/Money' recurringPayment: $ref: '#/components/schemas/Money' RewardBalance: title: RewardBalance type: object properties: expiryDate: type: string description: 'The date on which the balance expires.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceToReward: type: string description: 'The balance required to qualify for a reward such as retaining membership, business reward, etc.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceType: type: string description: 'The type of reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:Applicable Values
    ' readOnly: true enum: - EXPIRING_BALANCE - BALANCE_TO_LEVEL - BALANCE_TO_REWARD - BALANCE - TOTAL_BALANCE balance: type: number description: 'The actual reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' format: double readOnly: true description: type: string description: 'The description for the reward balance as available at provider source.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceToLevel: type: string description: 'The balance required to reach a reward level.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true units: type: string description: 'Unit of reward balance - miles, points, segments, dollars, credits.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true AccountDataset: title: AccountDataset type: object properties: lastUpdated: type: string description: 'Indicate when the dataset is last updated successfully for the given provider account.

    Account Type: Aggregated
    Endpoints:' readOnly: true updateEligibility: type: string description: 'Indicate whether the dataset is eligible for update or not.

    Account Type: Aggregated
    Endpoints:Applicable Values
    ' readOnly: true enum: - ALLOW_UPDATE - ALLOW_UPDATE_WITH_CREDENTIALS - DISALLOW_UPDATE additionalStatus: type: string description: 'The status of last update attempted for the dataset.

    Account Type: Aggregated
    Endpoints:Applicable Values
    ' readOnly: true 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 nextUpdateScheduled: type: string description: 'Indicates when the next attempt to update the dataset is scheduled.

    Account Type: Aggregated
    Endpoints:' readOnly: true name: type: string description: 'The name of the dataset requested from the provider site

    Account Type: Manual
    Endpoints:Applicable Values
    ' enum: - BASIC_AGG_DATA - ADVANCE_AGG_DATA - ACCT_PROFILE - DOCUMENT lastUpdateAttempt: type: string description: 'Indicate when the last attempt was performed to update the dataset for the given provider account

    Account Type: Aggregated
    Endpoints:' readOnly: true PaymentBankTransferCode: title: PaymentBankTransferCode type: object properties: id: type: string description: Value of the identifier readOnly: true type: type: string description: Type of BankTransferCode readOnly: true enum: - ROUTING_NUMBER - BSB - IFSC - SORT_CODE AccountHistoricalBalancesResponse: title: AccountHistoricalBalancesResponse type: object properties: account: type: array readOnly: true items: $ref: '#/components/schemas/AccountHistory' AutoRefresh: title: AutoRefresh type: object properties: additionalStatus: type: string description: Indicates the reason for the status.

    Endpoints:Applicable Values
    readOnly: true enum: - SCHEDULED - TEMP_ERROR - SITE_BLOCKING - SITE_NOT_SUPPORTED - REAL_TIME_MFA_REQUIRED - USER_ACTION_REQUIRED - UNSUBSCRIBED - MANUAL_ACCOUNT asOfDate: type: string description: Date on which the auto refresh status is determined.

    Endpoints: readOnly: true status: type: string description: Indicates whether auto refresh is enabled or disabled.

    Endpoints:Applicable Values
    readOnly: true enum: - ENABLED - DISABLED LoanPayoffDetails: title: LoanPayoffDetails type: object properties: payByDate: type: string description: 'The date by which the payoff amount should be paid.

    Account Type: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true payoffAmount: $ref: '#/components/schemas/Money' outstandingBalance: $ref: '#/components/schemas/Money' FullAccountNumberList: title: FullAccountNumberList type: object properties: paymentAccountNumber: type: string description: Payment Account Number of given account.

    Endpoints: readOnly: true unmaskedAccountNumber: type: string description: Unmasked account number of given account.

    Endpoints: readOnly: true HistoricalBalance: title: HistoricalBalance type: object properties: date: type: string 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:' readOnly: true isAsset: type: boolean description: 'Indicates whether the balance is an asset or liability.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:' readOnly: true balance: $ref: '#/components/schemas/Money' asOfDate: type: string 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:' readOnly: true dataSourceType: type: string description: 'The source of balance information.

    Aggregated / Manual: Both
    Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
    Endpoints:Applicable Values
    ' readOnly: true enum: - S - C - CF Money: title: Money type: object properties: amount: type: number description: Value of amount. format: double convertedAmount: type: number description: Value of the converted amount. format: double currency: type: string description: Currency should be a valid three-letter ISO Code. enum: - USD - AUD - BRL - CAD - EUR - GBP - HKD - IDR - INR - JPY - NZD - SGD - ZAR - CNY - VND - MYR - CHF - AED - AFA - ALL - AMD - ANG - AOA - ARS - AWG - AZM - BAM - BBD - BDT - BGL - BHD - BIF - BMD - BND - BOB - BSD - BTN - BWP - BYR - BZD - CDF - CLP - COP - CRC - CUP - CVE - CYP - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - FJD - FKP - GEL - GGP - GHC - GIP - GMD - GNF - GTQ - GYD - HNL - HRK - HTG - HUF - ILS - IMP - IQD - IRR - ISK - JEP - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGF - MKD - MMK - MNT - MOP - MRO - MTL - MUR - MVR - MWK - MXN - MZM - NAD - NGN - NIO - NOK - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - ROL - RUR - RWF - SAR - SBD - SCR - SDD - SEK - SHP - SIT - SKK - SLL - SOS - SPL - SRG - STD - SVC - SYP - SZL - THB - TJR - TMM - TND - TOP - TRL - TTD - TVD - TWD - TZS - UAH - UGX - UYU - UZS - VEB - VUV - WST - XAF - XAG - XAU - XCD - XDR - XOF - XPD - XPF - XPT - YER - YUM - ZMK - ZWD - ADP - ATS - BEF - BUK - CSD - CSK - DDM - DEM - ECS - ESP - FIM - GRD - GWP - IEP - ITL - LUF - MLF - NLG - PTE - SUR - TPE - UAK - XBA - XBB - XBC - XBD - XEU - XFO - XFU - XGF - XMK - XRM - XTS - YDD - YUD - ZRN - TJS - RON - BGN - BTC - XBT - CNH - RUB - TRY - GHS - TMT - ZMW - VEF - SSP - ALK convertedCurrency: type: string description: Currency should be a valid three-letter ISO Code. enum: - USD - AUD - BRL - CAD - EUR - GBP - HKD - IDR - INR - JPY - NZD - SGD - ZAR - CNY - VND - MYR - CHF - AED - AFA - ALL - AMD - ANG - AOA - ARS - AWG - AZM - BAM - BBD - BDT - BGL - BHD - BIF - BMD - BND - BOB - BSD - BTN - BWP - BYR - BZD - CDF - CLP - COP - CRC - CUP - CVE - CYP - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - FJD - FKP - GEL - GGP - GHC - GIP - GMD - GNF - GTQ - GYD - HNL - HRK - HTG - HUF - ILS - IMP - IQD - IRR - ISK - JEP - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGF - MKD - MMK - MNT - MOP - MRO - MTL - MUR - MVR - MWK - MXN - MZM - NAD - NGN - NIO - NOK - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - ROL - RUR - RWF - SAR - SBD - SCR - SDD - SEK - SHP - SIT - SKK - SLL - SOS - SPL - SRG - STD - SVC - SYP - SZL - THB - TJR - TMM - TND - TOP - TRL - TTD - TVD - TWD - TZS - UAH - UGX - UYU - UZS - VEB - VUV - WST - XAF - XAG - XAU - XCD - XDR - XOF - XPD - XPF - XPT - YER - YUM - ZMK - ZWD - ADP - ATS - BEF - BUK - CSD - CSK - DDM - DEM - ECS - ESP - FIM - GRD - GWP - IEP - ITL - LUF - MLF - NLG - PTE - SUR - TPE - UAK - XBA - XBB - XBC - XBD - XEU - XFO - XFU - XGF - XMK - XRM - XTS - YDD - YUD - ZRN - TJS - RON - BGN - BTC - XBT - CNH - RUB - TRY - GHS - TMT - ZMW - VEF - SSP - ALK CreateAccountInfo: title: CreateAccountInfo required: - accountName - accountType type: object properties: includeInNetWorth: type: string address: $ref: '#/components/schemas/AccountAddress' accountName: maxLength: 100 minLength: 1 type: string accountType: maxLength: 2147483647 minLength: 1 type: string dueDate: type: string memo: maxLength: 250 minLength: 0 type: string homeValue: $ref: '#/components/schemas/Money' accountNumber: maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9]+$ type: string frequency: type: string 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 amountDue: $ref: '#/components/schemas/Money' balance: $ref: '#/components/schemas/Money' nickname: maxLength: 50 minLength: 0 type: string valuationType: type: string enum: - SYSTEM - MANUAL AccountHolder: title: AccountHolder type: object properties: identifier: type: array description: 'Identifiers of the account holder.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/Identifier' gender: type: string description: 'Identifiers of the account holder.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:' readOnly: true ownership: type: string description: 'Indicates the ownership of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: bank
    Endpoints:Applicable Values
    ' readOnly: true enum: - PRIMARY - SECONDARY - CUSTODIAN - OTHERS - POWER_OF_ATTORNEY - TRUSTEE - JOINT_OWNER - BENEFICIARY - AAS - BUSINESS - DBA - TRUST name: $ref: '#/components/schemas/Name' UpdateAccountRequest: title: UpdateAccountRequest required: - account type: object properties: account: $ref: '#/components/schemas/UpdateAccountInfo' AccountBalanceResponse: title: AccountBalanceResponse type: object properties: accountBalance: type: array readOnly: true items: $ref: '#/components/schemas/AccountLatestBalance' AccountHistory: title: AccountHistory type: object properties: historicalBalances: type: array readOnly: true items: $ref: '#/components/schemas/HistoricalBalance' id: type: integer format: int64 readOnly: true AccountAddress: title: AccountAddress type: object properties: zip: type: string description: Zip. country: type: string description: Country. address3: type: string description: Address Line 3. address2: type: string description: Address Line 2. city: type: string description: City. sourceType: type: string address1: type: string description: Address Line 1. street: type: string state: type: string description: State. type: type: string enum: - HOME - BUSINESS - POBOX - RETAIL - OFFICE - SMALL_BUSINESS - COMMUNICATION - PERMANENT - STATEMENT_ADDRESS - PAYMENT - PAYOFF - UNKNOWN Email: title: Email type: object properties: type: type: string readOnly: true enum: - PRIMARY - SECONDARY - PERSONAL - WORK - OTHERS value: type: string readOnly: true CoverageAmount: title: CoverageAmount type: object properties: cover: $ref: '#/components/schemas/Money' unitType: type: string 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:Applicable Values:
    ' readOnly: true enum: - PER_FAMILY - PER_MEMBER type: type: string description: 'The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - DEDUCTIBLE - OUT_OF_POCKET - ANNUAL_BENEFIT - MAX_BENEFIT - COVERAGE_AMOUNT - MONTHLY_BENEFIT - OTHER limitType: type: string 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:Applicable Values:
    ' readOnly: true enum: - IN_NETWORK - OUT_NETWORK met: $ref: '#/components/schemas/Money' CreateAccountRequest: title: CreateAccountRequest required: - account type: object properties: account: $ref: '#/components/schemas/CreateAccountInfo' Name: title: Name type: object properties: middle: type: string description: Middle name. last: type: string description: Last name. fullName: type: string description: Full name. first: type: string description: First name. CreatedAccountResponse: title: CreatedAccountResponse type: object properties: account: type: array readOnly: true items: $ref: '#/components/schemas/CreatedAccountInfo' Coverage: title: Coverage type: object properties: amount: type: array description: 'The coverage amount-related details.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/CoverageAmount' planType: type: string description: 'The plan type for an insurance provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values:
    ' readOnly: true enum: - PPO - HMO - UNKNOWN endDate: type: string description: 'The date on which the coverage for the account ends or expires.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true type: type: string description: 'The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - VISION - DENTAL - MEDICAL - HEALTH - DEATH_COVER - TOTAL_PERMANENT_DISABILITY - ACCIDENTAL_DEATH_COVER - INCOME_PROTECTION - DEATH_TOTAL_PERMANENT_DISABILITY - OTHER startDate: type: string description: 'The date on which the coverage for the account starts.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true Identifier: title: Identifier type: object properties: type: type: string description: Type of Identifier readOnly: true enum: - NIE - DNI - EIN - BN - AADHAR - NIN - NRIC value: type: string description: Value of the identifier readOnly: true EvaluateAddressResponse: title: EvaluateAddressResponse type: object properties: address: type: array readOnly: true items: $ref: '#/components/schemas/AccountAddress' isValidAddress: type: boolean PhoneNumber: title: PhoneNumber type: object properties: type: type: string description: type of phone number readOnly: true enum: - HOME - WORK - LANDLINE - MOBILE value: type: string description: Phone Number readOnly: true AccountProfile: title: AccountProfile type: object properties: identifier: type: array description: 'Identifiers available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/Identifier' address: type: array description: 'Address available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/AccountAddress' phoneNumber: type: array description: 'Phone number available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/PhoneNumber' email: type: array description: 'Email Id available in the profile page of the account.

    Account Type: Aggregated
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/Email'