Envestnet · Schema

ProviderAccountPreferences

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
isDataExtractsEnabled boolean Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.

Endpoints:
  • GET providerAccounts
linkedProviderAccountId integer LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account.
LinkedProviderAccountId and the providerAccountId belongs to the same institution.

Endpo
isAutoRefreshEnabled boolean Indicates if auto-refreshes have to be triggered for the provider account.

Endpoints:
  • GET providerAccounts?include=preferences
  • GET providerAccounts/{providerAccountId}?inc
View JSON Schema on GitHub

JSON Schema

envestnet-provideraccountpreferences-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProviderAccountPreferences",
  "title": "ProviderAccountPreferences",
  "type": "object",
  "properties": {
    "isDataExtractsEnabled": {
      "type": "boolean",
      "description": "Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
    },
    "linkedProviderAccountId": {
      "type": "integer",
      "description": "LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account. <br>LinkedProviderAccountId and the providerAccountId belongs to the same institution.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li><li>GET Provider Accounts</li></ul>",
      "format": "int64"
    },
    "isAutoRefreshEnabled": {
      "type": "boolean",
      "description": "Indicates if auto-refreshes have to be triggered for the provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
    }
  }
}