Envestnet · Schema

Row

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
fieldRowChoice string Fields that belong to a particular choice are collected together using this field.
Recommendations: All the field row choices label to be grouped and displayed as options to the customer. On
field array Details of fields that belong to the row.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
form string Form denotes the set of the fields that are related.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
id string Unique identifier of the row.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
label string The label text displayed for a row in the form.

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

JSON Schema

envestnet-row-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Row",
  "title": "Row",
  "type": "object",
  "properties": {
    "fieldRowChoice": {
      "type": "string",
      "description": "Fields that belong to a particular choice are collected together using this field.<br><b>Recommendations</b>: All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. First field choice could be selected by default.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "field": {
      "type": "array",
      "description": "Details of fields that belong to the row.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    },
    "form": {
      "type": "string",
      "description": "Form denotes the set of the fields that are related. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of the row.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "label": {
      "type": "string",
      "description": "The label text displayed for a row in the form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    }
  }
}