Envestnet · Schema

CreateConsentRequest

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
providerId integer Unique identifier for the provider site.(e.g., financial institution sites, biller sites, lender sites, etc.).

Endpoints:
  • POST Consent
dataset array The name of the dataset attribute supported by the provider.If no dataset value is provided, the datasets that are configured for the customer will be considered.The configured dataset can be overridd
applicationName string The name of the application.If no applicationName is provided in the input, the default applicationName will be considered

Endpoints:
  • POST Consent
View JSON Schema on GitHub

JSON Schema

envestnet-createconsentrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateConsentRequest",
  "title": "CreateConsentRequest",
  "type": "object",
  "properties": {
    "providerId": {
      "type": "integer",
      "description": "Unique identifier for the provider site.(e.g., financial institution sites, biller sites, lender sites, etc.).<br><br><b>Endpoints</b>:<ul><li>POST Consent</li></ul>",
      "format": "int64"
    },
    "dataset": {
      "type": "array",
      "description": "The name of the dataset attribute supported by the provider.If no dataset value is provided, the datasets that are configured for the customer will be considered.The configured dataset can be overridden by providing the dataset as an input.<br><br><b>Endpoints</b>:<ul><li>POST Consent</li></ul>",
      "items": {
        "$ref": "#/components/schemas/ProvidersDataset"
      }
    },
    "applicationName": {
      "type": "string",
      "description": "The name of the application.If no applicationName is provided in the input, the default applicationName will be considered<br><br><b>Endpoints</b>:<ul><li>POST Consent</li></ul>"
    }
  }
}