Envestnet · Schema

Scope

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
titleBody array Title body that explains the purpose of the scope.
scopeId string Unique Dataset Cluster name for the consent group like
ACCOUNT_DETAILS
STATEMENT_DETAILS
CONTACT_DETAILS
TRANSACTION_DETAILS
datasetAttributes array Permissions that are associated with the Consent group like
BASIC_AGG_DATA.BASIC_ACCOUNT_INFO
BASIC_AGG_DATA.ACCOUNT_DETAILS
BASIC_AGG_DATA.STATEMENTS
BASIC_AGG_DATA.TRANSACTIONS
title string Title for the Data Cluster.
View JSON Schema on GitHub

JSON Schema

envestnet-scope-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Scope",
  "title": "Scope",
  "required": [
    "scopeId",
    "title",
    "titleBody"
  ],
  "type": "object",
  "properties": {
    "titleBody": {
      "type": "array",
      "description": "Title body that explains the purpose of the scope.",
      "items": {
        "type": "string"
      }
    },
    "scopeId": {
      "type": "string",
      "description": "Unique Dataset Cluster name for the consent group like <br/> ACCOUNT_DETAILS<br/> STATEMENT_DETAILS<br/> CONTACT_DETAILS<br/> TRANSACTION_DETAILS",
      "enum": [
        "ACCOUNT_DETAILS",
        "TRANSACTION_DETAILS",
        "STATEMENT_DETAILS",
        "CONTACT_DETAILS"
      ]
    },
    "datasetAttributes": {
      "type": "array",
      "description": "Permissions that are associated with the Consent group like<br/> BASIC_AGG_DATA.BASIC_ACCOUNT_INFO<br/> BASIC_AGG_DATA.ACCOUNT_DETAILS<br/> BASIC_AGG_DATA.STATEMENTS<br/> BASIC_AGG_DATA.TRANSACTIONS<br/> ACCT_PROFILE.HOLDER_NAME<br/> ACCT_PROFILE.FULL_ACCT_NUMBER<br/> ACCT_PROFILE.BANK_TRANSFER_CODE<br/> ACCT_PROFILE.HOLDER_DETAILS",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "type": "string",
      "description": "Title for the Data Cluster."
    }
  }
}