Envestnet · Schema

AutoRefresh

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
additionalStatus string Indicates the reason for the status.

Endpoints:
  • GET accounts
  • GET accounts/{accountId}
Applicable Values
asOfDate string Date on which the auto refresh status is determined.

Endpoints:
  • GET accounts
  • GET accounts/{accountId}
status string Indicates whether auto refresh is enabled or disabled.

Endpoints:
  • GET accounts
  • GET accounts/{accountId}
Applicable Values
View JSON Schema on GitHub

JSON Schema

envestnet-autorefresh-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AutoRefresh",
  "title": "AutoRefresh",
  "type": "object",
  "properties": {
    "additionalStatus": {
      "type": "string",
      "description": "Indicates the reason for the status.<br><br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values</b><br>",
      "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.<br><br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "description": "Indicates whether auto refresh is enabled or disabled.<br><br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "ENABLED",
        "DISABLED"
      ]
    }
  }
}