Envestnet · Schema

Option

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
displayText string The text that is displayed to the user for that option in the provider site.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
optionValue string The value that is associated with the option.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
isSelected boolean The option that is selected by default in the provider site.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
View JSON Schema on GitHub

JSON Schema

envestnet-option-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Option",
  "title": "Option",
  "type": "object",
  "properties": {
    "displayText": {
      "type": "string",
      "description": "The text that is displayed to the user for that option in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "optionValue": {
      "type": "string",
      "description": "The value that is associated with the option.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "isSelected": {
      "type": "boolean",
      "description": "The option that is selected by default in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    }
  }
}