Envestnet Account Aggregation API

Aggregation APIs give you the power to access accounts at most institutions in the industry, combined with the industry's best data enrichment augmented by powerful AI-driven data analysis, all from a single open-banking-ready platform.

OpenAPI Specification

envestnet-account-aggregation-openapi-original.yml Raw ↑
openapi: "3.0.1"
info:
  title: "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-Version: 1.1</li></ul><b>Note</b>: 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: "[email protected]"
  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"
  - name: "Auth"
    description: "Auth API"
  - name: "Configs"
    description: "Configs API"
  - name: "Consents"
    description: "Consents API"
  - name: "DataExtracts"
    description: "DataExtracts API"
  - name: "Derived"
    description: "Derived API"
  - name: "Documents"
    description: "Documents API"
  - name: "Holdings"
    description: "Holdings API"
  - name: "ProviderAccounts"
    description: "Provider Accounts API"
  - name: "Providers"
    description: "Providers API"
  - name: "Statements"
    description: "Statements API"
  - name: "Transactions"
    description: "Transactions API"
  - name: "User"
    description: "Users API"
paths:
  /consents/preferences:
    get:
      tags:
        - "Consents"
      summary: "Envestnet Get Consents Preferences"
      description: "This API service provides user's preferences for the consent"
      operationId: "getConsentPreferences"
      parameters:
        - name: "consentId"
          in: "query"
          description: "consentId"
          required: true
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/ConsentPreferencesResponse"
        400:
          description: "Y800 : Invalid value for consentId <br/>Y812 :Required field/value - consentId missing in the request <br/>"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /transactions:
    get:
      tags:
        - "Transactions"
      summary: "Envestnet Get Transactions"
      description: "The Transaction service is used to get a list of transactions for a user.<br>By default, this service returns the last 30 days of transactions from today's date.<br>API will only return up to 2 years of transaction history. If the difference between fromDate and toDate is more than 2 years, API will return only last 2 years from the toDate.<br>The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.<br>Values for categoryId parameter can be fetched from get transaction category list service.<br> The categoryId is used to filter transactions based on system-defined category as well as user-defined category.<br>User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002<br>The skip and top parameters are used for pagination. In the skip and top parameters pass the number of records to be skipped and retrieved, respectively. The response header provides the links to retrieve the next and previous set of transactions.<br>Double quotes in the merchant name will be prefixed by backslashes (&#92;) in the response, e.g. Toys \"R\" Us. <br>sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.<br><br><b>Note</b><ul><li><a href=\"https://developer.envestnet.com/resources/yodlee/transaction-data-enrichment/docs/overview\">Transaction Data Enrichment</a> is made available for bank and card accounts. The address field in the response is available only when the Transaction Data Enrichment key is turned ON.</li><li>The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 transactions.</li><li>This service supports the localization feature and accepts locale as a header parameter.</li></ul>"
      operationId: "getTransactions"
      parameters:
        - name: "accountId"
          in: "query"
          description: "Comma separated accountIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "baseType"
          in: "query"
          description: "DEBIT/CREDIT"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryId"
          in: "query"
          description: "Comma separated categoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryType"
          in: "query"
          description: "Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "container"
          in: "query"
          description: "bank/creditCard/investment/insurance/loan"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "convertToCurrency"
          in: "query"
          description: "On-demand currency conversion parameter"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "detailCategoryId"
          in: "query"
          description: "Comma separated detailCategoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "fromDate"
          in: "query"
          description: "Transaction from date(YYYY-MM-DD)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "highLevelCategoryId"
          in: "query"
          description: "Comma separated highLevelCategoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "keyword"
          in: "query"
          description: "Transaction search text"
          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: "Transaction end date (YYYY-MM-DD)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "top"
          in: "query"
          description: "top (Max 500)"
          allowEmptyValue: false
          schema:
            type: "integer"
            format: "int32"
        - name: "type"
          in: "query"
          description: "Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment"
          allowEmptyValue: false
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
        400:
          description: "Y800 : Invalid value for baseType<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for category<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for container<br>Y809 : Invalid date range<br>Y804 : Permitted values of top between 1 - 500<br>Y805 : Multiple containers not supported<br>Y800 : Invalid value for transaction type<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of highLevelCategoryIds permitted is 100<br>Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled<br>Y823 : detailCategoryId is not for applicable containers other than bank and card<br>Y824 : The maximum number of detailCategoryIds permitted is 100<br>Y800 : Invalid value for detailCategoryId<br>Y800 : Invalid value for convertToCurrency<br>Y820 : The currency value is not supported for convertToCurrency<br>"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /auth/apiKey/{key}:
    delete:
      tags:
        - "Auth"
      summary: "Envestnet Delete API Key"
      description: "This endpoint allows an existing API key to be deleted.<br>You can use one of the following authorization methods to access this API:<br><ol><li>cobsession</li><li>JWT token</li></ol> <b>Notes:</b> <li>This service is not available in developer sandbox environment and will be made availablefor testing in your dedicated environment. "
      operationId: "deleteApiKey"
      parameters:
        - name: "key"
          in: "path"
          description: "key"
          required: true
          schema:
            type: "string"
      responses:
        201:
          description: "OK"
          content: {}
        204:
          description: "No Content"
          content: {}
        400:
          description: "Y807 : Resource not found<br>Y806 : Invalid input"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /providerAccounts:
    get:
      tags:
        - "ProviderAccounts"
      summary: "Envestnet Get Provider Accounts"
      description: "The get provider accounts service is used to return all the provider accounts added by the user. <br>This includes the failed and successfully added provider accounts.<br>"
      operationId: "getAllProviderAccounts"
      parameters:
        - name: "include"
          in: "query"
          description: "include"
          schema:
            type: "string"
        - name: "providerIds"
          in: "query"
          description: "Comma separated providerIds."
          allowEmptyValue: false
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/ProviderAccountResponse"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
    put:
      tags:
        - "ProviderAccounts"
      summary: "Envestnet Update Account"
      description: "<i>This API Reference guide is intended for FastLink 4 Users.  For FastLink 3 Users, there are additional integration notes related to this endpoint <a href=\"https://developer.envestnet.com/resources/yodlee/fastlink-3/docs/api-integrations\">here</a>.</i><br><br>The update account API is used to:<br> <ul><li>Retrieve the latest information of all the eligible accounts that belong to the user.<li>Check the status of the providerAccount before invoking this API. Do not call this API to trigger any action on a providerAccount when an action is already in progress for the providerAccount.<li>If the customer has subscribed to the REFRESH event notification and invoked this API, relevant notifications will be sent to the customer.<li>Check all the dataset additional statuses returned in the response because the provider account status is drawn from the dataset additional statuses.<li>Updating preferences using this API will trigger refreshes.<li> The content type has to be passed as application/json for the body parameter.</ul><br>-----------------------------------------------------------------------------------------------------------------------------------------<br><br><b>Update All Eligible Accounts - Notes:</b><br><ul><li>This API will trigger a refresh for all the eligible provider accounts(both OB and credential-based accounts).<li>This API will not refresh closed, inactive, or UAR accounts, or accounts with refreshes in-progress or recently refreshed non-OB accounts.<li>No parameters should be passed to this API to trigger this action.<li>Do not call this API often. Our recommendation is to call this only at the time the user logs in to your app because it can hamper other API calls performance.<li>The response only contains information for accounts that were refreshed. If no accounts are eligible for refresh, no response is returned.</ul>"
      operationId: "editCredentialsOrRefreshProviderAccount"
      parameters:
        - name: "providerAccountIds"
          in: "query"
          description: "comma separated providerAccountIds"
          required: true
          allowEmptyValue: false
          schema:
            type: "string"
      requestBody:
        description: "loginForm or field entity"
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProviderAccountRequest"
        required: false
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/UpdatedProviderAccountResponse"
        400:
          description: "Y805 : Multiple providerAccountId not supported for updating credentials<br>Y800 : Invalid value for credentialsParam<br>Y400 : id and value in credentialsParam are mandatory<br>Y806 : Invalid input<br>Y823 : Credentials are not applicable for real estate aggregated / manual accounts<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /transactions/count:
    get:
      tags:
        - "Transactions"
      summary: "Envestnet Get Transactions Count"
      description: "The count service provides the total number of transactions for a specific user depending on the input parameters passed.<br>If you are implementing pagination for transactions, call this endpoint before calling GET /transactions to know the number of transactions that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /transactions endpoint.<br>"
      operationId: "getTransactionsCount"
      parameters:
        - name: "accountId"
          in: "query"
          description: "Comma separated accountIds\t"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "baseType"
          in: "query"
          description: "DEBIT/CREDIT"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryId"
          in: "query"
          description: "Comma separated categoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryType"
          in: "query"
          description: "Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "container"
          in: "query"
          description: "bank/creditCard/investment/insurance/loan"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "detailCategoryId"
          in: "query"
          description: "Comma separated detailCategoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "fromDate"
          in: "query"
          description: "Transaction from date(YYYY-MM-DD)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "highLevelCategoryId"
          in: "query"
          description: "Comma separated highLevelCategoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "keyword"
          in: "query"
          description: "Transaction search text\t"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "toDate"
          in: "query"
          description: "Transaction end date (YYYY-MM-DD)"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "type"
          in: "query"
          description: "Transaction Type(SELL,SWEEP, etc.)"
          allowEmptyValue: false
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/TransactionCountResponse"
        400:
          description: "Y800 : Invalid value for detailCategoryId<br>Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled<br>Y823 : detailCategoryId is not applicable for containers other than bank and card<br>Y824 : The maximum number of detailCategoryIds permitted is 100<br>"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /derived/transactionSummary:
    get:
      tags:
        - "Derived"
      summary: "Envestnet Get Transaction Summary"
      description: "The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.<br><br>Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.<br><br><b>Notes:</b><ol> <li> Details can be requested for only one system-defined category<li>Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE<li>Dates will not be respected for monthly, yearly, and weekly details<li>When monthly details are requested, only the fromDate and toDate month will be respected<li>When yearly details are requested, only the fromDate and toDate year will be respected<li>For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate<li>This service supports the localization feature and accepts locale as a header parameter</li></ol>"
      operationId: "getTransactionSummary"
      parameters:
        - name: "accountId"
          in: "query"
          description: "comma separated account Ids"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryId"
          in: "query"
          description: "comma separated categoryIds"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "categoryType"
          in: "query"
          description: "LOAN, INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "fromDate"
          in: "query"
          description: "YYYY-MM-DD format"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "groupBy"
          in: "query"
          description: "CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY"
          required: true
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "include"
          in: "query"
          description: "details"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "includeUserCategory"
          in: "query"
          description: "TRUE/FALSE"
          allowEmptyValue: false
          schema:
            type: "boolean"
        - name: "interval"
          in: "query"
          description: "D-daily, W-weekly, M-mothly or Y-yearly"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "toDate"
          in: "query"
          description: "YYYY-MM-DD format"
          allowEmptyValue: false
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/DerivedTransactionSummaryResponse"
        400:
          description: "Y010 : Invalid session<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for groupBy<br>Y803 : groupBy required<br>Y803 : categoryType required<br>Y800 : Invalid value for categoryId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for fromDate or toDate<br>Y814 : Exchange rate not available for currency<br>Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE<br>Y816 : User-defined category details can only be requested for one system categoryId with groupBy='CATEGORY'<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of categoryTypes 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
  /consents/{consentId}/renewal:
    put:
      tags:
        - "Consents"
      summary: "Envestnet Renew Consent"
      description: "The consent renewal service is used to renew the consent by validating the consent state. This API supports both UK and AU Open Banking. </br><b>Renewing an UK Open Banking consent:</b><br><li>Before the grace period of 90 days: The consent will be renewed using the third-party provider (TPP) renewal process that Yodlee does, and no consent reauthorisation is required.The API response will contain the complete renewed consent object.</li><li>After the grace period of 90 days: The API will provide an authorisation URL to redirect the user to the financial institution site to complete the consent reauthorization process.<br><b>Renewing an AU Open Banking consent:</b><br><li>Invoke this API, and in the API response, an authorisation URL will be provided to redirect the user to the financial institution site to complete the consent reauthorisation process.</li><br>"
      operationId: "renewConsent"
      parameters:
        - name: "consentId"
          in: "path"
          description: "Consent Id to be renewed."
          required: true
          schema:
            type: "integer"
            format: "int64"
      requestBody:
        description: "renewal entity from consent details service."
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RenewConsentRequest"
        required: false
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/RenewConsentResponse"
        400:
          description: "Y800 : Invalid value for consentId <br/>Y800 : Invalid value for consentParam <br/>Y802 : The consent duration days is outside of the range selected during onboarding, hence consentDurationDays not allowed<br/>Y803 : consent duration days preference required consentParam <br/>Y812 : Required field/value - scopeId missing in the consentParam <br/>"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /dataExtracts/userData:
    get:
      tags:
        - "DataExtracts"
      summary: "Envestnet Get userData"
      description: "The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.<br>The time difference between fromDate and toDate fields cannot be more than 60 minutes.<br>By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.<br>In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.<br>This service is only invoked with either admin access token or a cobrand session.<br/>Refer to <a href=\"https://developer.envestnet.com/resources/yodlee/data-extracts/docs/overview\">dataExtracts</a> page for more information.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.</li>"
      operationId: "getDataExtractsUserData"
      parameters:
        - name: "fromDate"
          in: "query"
          description: "From DateTime (YYYY-MM-DDThh:mm:ssZ)"
          required: true
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "loginName"
          in: "query"
          description: "Login Name"
          required: true
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "toDate"
          in: "query"
          description: "To DateTime (YYYY-MM-DDThh:mm:ssZ)"
          required: true
          allowEmptyValue: false
          schema:
            type: "string"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/DataExtractsUserDataResponse"
        400:
          description: "Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName"
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: "#/components/schemas/YodleeError"
        401:
          description: "Unauthorized"
          content: {}
        404:
          description: "Not Found"
          content: {}
      deprecated: false
  /providers:
    get:
      tags:
        - "Providers"
      summary: "Envestnet Get Providers"
      description: "<i>This API Reference guide is intended for FastLink 4 Users.  For FastLink 3 Users, there are additional integration notes related to this endpoint <a href=\"https://developer.envestnet.com/resources/yodlee/fastlink-3/docs/api-integrations\">here</a>.</i><br><br>The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region.<br><br>Searching for a provider using a routing number is applicable only to the USA and Canada regions.<br> The valid values for priority are: <br><ol><li> cobrand: Returns providers enabled for the cobrand (Default priority)</li><li>popular: Returns providers popular among users of the customer.</li></ol><br>The skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively.The response header provides the links to retrieve the next and previous set of transactions.<br><br> Providers accept the configName as the input to the API and return the providers list based on the configurations of each configName.  For verification, the providers will accept the configName with which has the verification product and the attributes that are chosen in the configName which returns the list of providers that match the criteria. For example,  /ysl/providers?configName=aggregationAndVerification<br><br>Note:</b> <ol><li>In a product flow involving user interaction, Yodlee recommends invoking this service with filters.<li>Without filters, the service may perform slowly as it takes a few minutes to return data in the response.<li>The AuthParameter appears in the response only in case of token-based aggregation sites.<li>The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.<li>This service supports the localization feature and accepts locale as a header parameter.<li>The capability has been deprecated in query parameter and response. </li></ol>"
      operationId: "getAllProviders"
      parameters:
        - name: "capability"
          in: "query"
          description: "CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "dataset$filter"
          in: "query"
          description: "Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer."
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "fullAccountNumberFields"
          in: "query"
          description: "Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber."
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "institutionId"
          in: "query"
          description: "Institution Id for Single site selection"
          allowEmptyValue: false
          schema:
            type: "integer"
            format: "int64"
        - name: "name"
          in: "query"
          description: "Name in minimum 1 character or routing number."
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "priority"
          in: "query"
          description: "Search priority"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "providerId"
          in: "query"
          description: "Max 5 Comma seperated Provider Ids"
          allowEmptyValue: false
          schema:
            type: "string"
        - name: "skip"
          in: "query"
          description: "skip (Min 0) - This is not applicable along with 'name' parameter."
          allowEmptyValue: false
          schema:
            type: "integer"
            format: "int32"
        - name: "top"
          in: "query"
          description: "top (Max 500) - This is not applicable along with 'name' parameter."
          allowEmptyValue: false
          schema:
            type: "integer"
            format: "int32"
      responses:
        200:
          description: "OK"
          content:
            application/json;charset=UTF-8

# --- truncated at 32 KB (464 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/envestnet/refs/heads/main/openapi/envestnet-account-aggregation-openapi-original.yml