Envestnet Aggregation APIs

naftiko: 1.0.0-alpha2
info:
  label: Envestnet Aggregation APIs
  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 <a href="https://developer.envestnet.com/resources/yodlee/yodlee-api-overview/docs">Yodlee
    API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply
    to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Ve'
  tags:
  - Envestnet
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: envestnet
    baseUri: ''
    description: Envestnet Aggregation APIs HTTP API.
    resources:
    - name: consents-preferences
      path: /consents/preferences
      operations:
      - name: getconsentpreferences
        method: GET
        description: Envestnet Get Consents Preferences
        inputParameters:
        - name: consentId
          in: query
          type: string
          required: true
          description: consentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions
      path: /transactions
      operations:
      - name: gettransactions
        method: GET
        description: Envestnet Get Transactions
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: Comma separated accountIds
        - name: baseType
          in: query
          type: string
          description: DEBIT/CREDIT
        - name: categoryId
          in: query
          type: string
          description: Comma separated categoryIds
        - name: categoryType
          in: query
          type: string
          description: Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)
        - name: container
          in: query
          type: string
          description: bank/creditCard/investment/insurance/loan
        - name: convertToCurrency
          in: query
          type: string
          description: On-demand currency conversion parameter
        - name: detailCategoryId
          in: query
          type: string
          description: Comma separated detailCategoryIds
        - name: fromDate
          in: query
          type: string
          description: Transaction from date(YYYY-MM-DD)
        - name: highLevelCategoryId
          in: query
          type: string
          description: Comma separated highLevelCategoryIds
        - name: keyword
          in: query
          type: string
          description: Transaction search text
        - name: skip
          in: query
          type: integer
          description: skip (Min 0)
        - name: toDate
          in: query
          type: string
          description: Transaction end date (YYYY-MM-DD)
        - name: top
          in: query
          type: integer
          description: top (Max 500)
        - name: type
          in: query
          type: string
          description: Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-apikey-key
      path: /auth/apiKey/{key}
      operations:
      - name: deleteapikey
        method: DELETE
        description: Envestnet Delete API Key
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
          description: key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: provideraccounts
      path: /providerAccounts
      operations:
      - name: getallprovideraccounts
        method: GET
        description: Envestnet Get Provider Accounts
        inputParameters:
        - name: include
          in: query
          type: string
          description: include
        - name: providerIds
          in: query
          type: string
          description: Comma separated providerIds.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: editcredentialsorrefreshprovideraccount
        method: PUT
        description: Envestnet Update Account
        inputParameters:
        - name: providerAccountIds
          in: query
          type: string
          required: true
          description: comma separated providerAccountIds
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-count
      path: /transactions/count
      operations:
      - name: gettransactionscount
        method: GET
        description: Envestnet Get Transactions Count
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: Comma separated accountIds
        - name: baseType
          in: query
          type: string
          description: DEBIT/CREDIT
        - name: categoryId
          in: query
          type: string
          description: Comma separated categoryIds
        - name: categoryType
          in: query
          type: string
          description: Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)
        - name: container
          in: query
          type: string
          description: bank/creditCard/investment/insurance/loan
        - name: detailCategoryId
          in: query
          type: string
          description: Comma separated detailCategoryIds
        - name: fromDate
          in: query
          type: string
          description: Transaction from date(YYYY-MM-DD)
        - name: highLevelCategoryId
          in: query
          type: string
          description: Comma separated highLevelCategoryIds
        - name: keyword
          in: query
          type: string
          description: Transaction search text
        - name: toDate
          in: query
          type: string
          description: Transaction end date (YYYY-MM-DD)
        - name: type
          in: query
          type: string
          description: Transaction Type(SELL,SWEEP, etc.)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: derived-transactionsummary
      path: /derived/transactionSummary
      operations:
      - name: gettransactionsummary
        method: GET
        description: Envestnet Get Transaction Summary
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: comma separated account Ids
        - name: categoryId
          in: query
          type: string
          description: comma separated categoryIds
        - name: categoryType
          in: query
          type: string
          description: LOAN, INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION
        - name: fromDate
          in: query
          type: string
          description: YYYY-MM-DD format
        - name: groupBy
          in: query
          type: string
          required: true
          description: CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY
        - name: include
          in: query
          type: string
          description: details
        - name: includeUserCategory
          in: query
          type: boolean
          description: TRUE/FALSE
        - name: interval
          in: query
          type: string
          description: D-daily, W-weekly, M-mothly or Y-yearly
        - name: toDate
          in: query
          type: string
          description: YYYY-MM-DD format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consents-consentid-renewal
      path: /consents/{consentId}/renewal
      operations:
      - name: renewconsent
        method: PUT
        description: Envestnet Renew Consent
        inputParameters:
        - name: consentId
          in: path
          type: integer
          required: true
          description: Consent Id to be renewed.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: dataextracts-userdata
      path: /dataExtracts/userData
      operations:
      - name: getdataextractsuserdata
        method: GET
        description: Envestnet Get userData
        inputParameters:
        - name: fromDate
          in: query
          type: string
          required: true
          description: From DateTime (YYYY-MM-DDThh:mm:ssZ)
        - name: loginName
          in: query
          type: string
          required: true
          description: Login Name
        - name: toDate
          in: query
          type: string
          required: true
          description: To DateTime (YYYY-MM-DDThh:mm:ssZ)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: providers
      path: /providers
      operations:
      - name: getallproviders
        method: GET
        description: Envestnet Get Providers
        inputParameters:
        - name: capability
          in: query
          type: string
          description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        - name: dataset$filter
          in: query
          type: string
          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 '
        - name: fullAccountNumberFields
          in: query
          type: string
          description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        - name: institutionId
          in: query
          type: integer
          description: Institution Id for Single site selection
        - name: name
          in: query
          type: string
          description: Name in minimum 1 character or routing number.
        - name: priority
          in: query
          type: string
          description: Search priority
        - name: providerId
          in: query
          type: string
          description: Max 5 Comma seperated Provider Ids
        - name: skip
          in: query
          type: integer
          description: skip (Min 0) - This is not applicable along with 'name' parameter.
        - name: top
          in: query
          type: integer
          description: top (Max 500) - This is not applicable along with 'name' parameter.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: provideraccounts-refresh
      path: /providerAccounts/refresh
      operations:
      - name: refreshprovideraccount
        method: PUT
        description: Envestnet Refresh Provider Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: providers-providerid
      path: /providers/{providerId}
      operations:
      - name: getprovider
        method: GET
        description: Envestnet Get Provider Details
        inputParameters:
        - name: providerId
          in: path
          type: integer
          required: true
          description: providerId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-categories-txnrules
      path: /transactions/categories/txnRules
      operations:
      - name: gettransactioncategorizationrules
        method: GET
        description: Envestnet Get Transaction Categorization Rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-categories-categoryid
      path: /transactions/categories/{categoryId}
      operations:
      - name: deletetransactioncategory
        method: DELETE
        description: Envestnet Delete Category
        inputParameters:
        - name: categoryId
          in: path
          type: integer
          required: true
          description: categoryId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents
      path: /documents
      operations:
      - name: getdocuments
        method: GET
        description: Envestnet Get Documents
        inputParameters:
        - name: Keyword
          in: query
          type: string
          description: The string used to search a document by its name.
        - name: accountId
          in: query
          type: string
          description: The unique identifier of an account. Retrieve documents for a given accountId.
        - name: docType
          in: query
          type: string
          description: 'Accepts only one of the following valid document types: STMT, TAX, and EBILL.'
        - name: fromDate
          in: query
          type: string
          description: The date from which documents have to be retrieved.
        - name: toDate
          in: query
          type: string
          description: The date to which documents have to be retrieved.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accounts-evaluateaddress
      path: /accounts/evaluateAddress
      operations:
      - name: evaluateaddress
        method: POST
        description: Envestnet Evaluate Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accounts-accountid
      path: /accounts/{accountId}
      operations:
      - name: getaccount
        method: GET
        description: Envestnet Get Account Details
        inputParameters:
        - name: accountId
          in: path
          type: integer
          required: true
          description: accountId
        - name: convertToCurrency
          in: query
          type: string
          description: On-demand currency conversion parameter
        - name: include
          in: query
          type: string
          description: profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b>fullAccountNumber
            is deprecated and is replaced with fullA
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateaccount
        method: PUT
        description: Envestnet Update Account
        inputParameters:
        - name: accountId
          in: path
          type: integer
          required: true
          description: accountId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteaccount
        method: DELETE
        description: Envestnet Delete Account
        inputParameters:
        - name: accountId
          in: path
          type: integer
          required: true
          description: accountId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configs-notifications-events
      path: /configs/notifications/events
      operations:
      - name: getsubscribednotificationevents
        method: GET
        description: Envestnet Get Subscribed Notification Events
        inputParameters:
        - name: eventName
          in: query
          type: string
          description: Name of the webhook subscription event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consents-history-count
      path: /consents/history/count
      operations:
      - name: getconsenthistorycount
        method: GET
        description: Envestnet Get Consent History Count
        inputParameters:
        - name: consentId
          in: query
          type: string
          required: true
          description: Consent Id generated through POST Consent.
        - name: fromDate
          in: query
          type: string
          description: Consent History from date(YYYY-MM-DD)
        - name: toDate
          in: query
          type: string
          description: Consent History end date (YYYY-MM-DD)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: providers-count
      path: /providers/count
      operations:
      - name: getproviderscount
        method: GET
        description: Envestnet Get Providers Count
        inputParameters:
        - name: capability
          in: query
          type: string
          description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        - name: dataset$filter
          in: query
          type: string
          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 '
        - name: fullAccountNumberFields
          in: query
          type: string
          description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        - name: name
          in: query
          type: string
          description: Name in minimum 1 character or routing number.
        - name: priority
          in: query
          type: string
          description: Search priority
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accounts-historicalbalances
      path: /accounts/historicalBalances
      operations:
      - name: gethistoricalbalances
        method: GET
        description: Envestnet Get Historical Balances
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: accountId
        - name: fromDate
          in: query
          type: string
          description: from date for balance retrieval (YYYY-MM-DD)
        - name: includeCF
          in: query
          type: boolean
          description: Consider carry forward logic for missing balances
        - name: interval
          in: query
          type: string
          description: D-daily, W-weekly or M-monthly
        - name: skip
          in: query
          type: integer
          description: skip (Min 0)
        - name: toDate
          in: query
          type: string
          description: toDate for balance retrieval (YYYY-MM-DD)
        - name: top
          in: query
          type: integer
          description: top (Max 500)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consents-history
      path: /consents/history
      operations:
      - name: getconsenthistory
        method: GET
        description: Envestnet Get Consent History
        inputParameters:
        - name: consentId
          in: query
          type: string
          required: true
          description: Consent Id generated through POST Consent.
        - name: fromDate
          in: query
          type: string
          description: Consent History from date(YYYY-MM-DD)
        - name: skip
          in: query
          type: integer
          description: skip (Min 0)
        - name: toDate
          in: query
          type: string
          description: Consent History end date (YYYY-MM-DD)
        - name: top
          in: query
          type: integer
          description: top (Max 500)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: derived-networth
      path: /derived/networth
      operations:
      - name: getnetworth
        method: GET
        description: Envestnet Get Networth Summary
        inputParameters:
        - name: accountIds
          in: query
          type: string
          description: comma separated accountIds
        - name: container
          in: query
          type: string
          description: bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities
        - name: fromDate
          in: query
          type: string
          description: from date for balance retrieval (YYYY-MM-DD)
        - name: include
          in: query
          type: string
          description: details
        - name: interval
          in: query
          type: string
          description: D-daily, W-weekly or M-monthly
        - name: skip
          in: query
          type: integer
          description: skip (Min 0)
        - name: toDate
          in: query
          type: string
          description: toDate for balance retrieval (YYYY-MM-DD)
        - name: top
          in: query
          type: integer
          description: top (Max 500)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user-samllogin
      path: /user/samlLogin
      operations:
      - name: samllogin
        method: POST
        description: Envestnet Saml Login
        inputParameters:
        - name: issuer
          in: query
          type: string
          required: true
          description: issuer
        - name: samlResponse
          in: query
          type: string
          required: true
          description: samlResponse
        - name: source
          in: query
          type: string
          description: source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user-register
      path: /user/register
      operations:
      - name: registeruser
        method: POST
        description: Envestnet Register User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: holdings-securities
      path: /holdings/securities
      operations:
      - name: getsecurities
        method: GET
        description: Envestnet Get Security Details
        inputParameters:
        - name: holdingId
          in: query
          type: string
          description: Comma separated holdingId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configs-notifications-events-eventname
      path: /configs/notifications/events/{eventName}
      operations:
      - name: updatesubscribednotificationevent
        method: PUT
        description: Envestnet Update Notification Subscription
        inputParameters:
        - name: eventName
          in: path
          type: string
          required: true
          description: Name of the webhook subscription event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsubscriptionnotificationevent
        method: POST
        description: Envestnet Subscribe For Notification Event
        inputParameters:
        - name: eventName
          in: path
          type: string
          required: true
          description: Name of the webhook subscription event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletesubscribednotificationevent
        method: DELETE
        description: Envestnet Delete Notification Subscription
        inputParameters:
        - name: eventName
          in: path
          type: string
          required: true
          description: Name of the webhook subscription event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: holdings
      path: /holdings
      operations:
      - name: getholdings
        method: GET
        description: Envestnet Get Holdings
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: Comma separated accountId
        - name: assetClassification.classificationType
          in: query
          type: string
          description: e.g. Country, Sector, etc.
        - name: classificationValue
          in: query
          type: string
          description: e.g. US
        - name: include
          in: query
          type: string
          description: assetClassification
        - name: providerAccountId
          in: query
          type: string
          description: providerAccountId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addholding
        method: POST
        description: Envestnet Add Holding
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-apikey
      path: /auth/apiKey
      operations:
      - name: getapikeys
        method: GET
        description: Envestnet Get API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: generateapikey
        method: POST
        description: Envestnet Generate API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-categories-rules-ruleid
      path: /transactions/categories/rules/{ruleId}
      operations:
      - name: updatetransactioncategorizationrule
        method: PUT
        description: Envestnet Update Transaction Categorization Rule
        inputParameters:
        - name: ruleId
          in: path
          type: integer
          required: true
          description: ruleId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: runtransactioncategorizationrule
        method: POST
        description: Envestnet Run Transaction Categorization Rule
        inputParameters:
        - name: action
          in: query
          type: string
          required: true
        - name: ruleId
          in: path
          type: integer
          required: true
          description: Unique id of the categorization rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletetransactioncategorizationrule
        method: DELETE
        description: Envestnet Delete Transaction Categorization Rule
        inputParameters:
        - name: ruleId
          in: path
          type: integer
          required: true
          description: ruleId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents-documentid
      path: /documents/{documentId}
      operations:
      - name: downloaddocument
        method: GET
        description: Envestnet Download a Document
        inputParameters:
        - name: documentId
          in: path
          type: string
          required: true
          description: documentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedocument
        method: DELETE
        description: Envestnet Delete Document
        inputParameters:
        - name: documentId
          in: path
          type: string
          required: true
          description: documentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user-accesstokens
      path: /user/accessTokens
      operations:
      - name: getaccesstokens
        method: GET
        description: Envestnet Get Access Tokens
        inputParameters:
        - name: appIds
          in: query
          type: string
          required: true
          description: appIds
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consents-consentid
      path: /consents/{consentId}
      operations:
      - name: getconsentdetails
        method: GET
        description: Envestnet Get Authorization Details
        inputParameters:
        - name: consentId
          in: path
          type: integer
          required: true
          description: Consent Id generated through POST Consent.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateconsent
        method: PUT
        description: Envestnet Put Consent
        inputParameters:
        - name: consentId
          in: path
          type: integer
          required: true
          description: Consent Id generated through POST Consent.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: provideraccounts-provideraccountid-preferences
      path: /providerAccounts/{providerAccountId}/preferences
      operations:
      - name: updatepreferences
        method: PUT
        description: Envestnet Update Preferences
        inputParameters:
        - name: providerAccountId
          in: path
          type: integer
          required: true
          description: providerAccountId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-token
      path: /auth/token
      operations:
      - name: generateaccesstoken
        method: POST
        description: Envestnet Generate Access Token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletetoken
        method: DELETE
        description: Envestnet Delete Token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user
      path: /user
      operations:
      - name: getuser
        method: GET
        description: Envestnet Get User Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Envestnet Update User Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: provideraccounts-provideraccountid
      path: /providerAccounts/{providerAccountId}
      operations:
      - name: getprovideraccount
        method: GET
        description: Envestnet Get Provider Account Details
        inputParameters:
        - name: include
          in: query
          type: string
          description: include credentials,questions
        - name: providerAccountId
          in: path
          type: integer
          required: true
          description: providerAccountId
        - name: requestId
          in: query
          type: string
          description: The unique identifier for the request that returns contextual data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteprovideraccount
        method: DELETE
        description: Envestnet Delete Provider Account
        inputParameters:
        - name: providerAccountId
          in: path
          type: integer
          required: true
          description: providerAccountId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-categories
      path: /transactions/categories
      operations:
      - name: gettransactioncategories
        method: GET
        description: Envestnet Get Transaction Category List
        outputRawFormat: json
        outputPar

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/envestnet/refs/heads/main/capabilities/envestnet-capability.yaml