Envestnet · Schema

ProviderAccountRequest

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name	Type	Description
consentId	integer	Consent Id generated for the request through POST Consent. Endpoints: POST Provider Account PUT Provider Account
preferences	object
aggregationSource	string
field	array
datasetName	array
dataset	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProviderAccountRequest",
  "title": "ProviderAccountRequest",
  "required": [
    "field"
  ],
  "type": "object",
  "properties": {
    "consentId": {
      "type": "integer",
      "description": "Consent Id generated for the request through POST Consent.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li></ul>",
      "format": "int64"
    },
    "preferences": {
      "$ref": "#/components/schemas/ProviderAccountPreferences"
    },
    "aggregationSource": {
      "type": "string",
      "enum": [
        "SYSTEM",
        "USER"
      ]
    },
    "field": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    },
    "datasetName": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "BASIC_AGG_DATA",
          "ADVANCE_AGG_DATA",
          "ACCT_PROFILE",
          "DOCUMENT"
        ]
      }
    },
    "dataset": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProvidersDataset"
      }
    }
  }
}