Envestnet · Schema

EligibleInsight

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
insightName string Name of the Insight for which this notification is generated.

Endpoints -
  • GET insights/configs/customerSubscriptions customer API
  • GET insights/configs/userSubscriptions
applicableConfiguration array
View JSON Schema on GitHub

JSON Schema

envestnet-eligibleinsight-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EligibleInsight",
  "title": "EligibleInsight",
  "properties": {
    "insightName": {
      "type": "string",
      "description": "Name of the Insight for which this notification is generated. <br><br><b>Endpoints</b> - <ul><li>GET insights/configs/customerSubscriptions customer API</li>\n                      <li>GET insights/configs/userSubscriptions User API</li>\n                      <li>PATCH /insights/configs/customerSubscriptions cusomter API</li>\n                      <li>PATCH /insights/configs/userSubscriptions User API</li>\n                      <li>GET /insights/entityDetail/{entityId}</li>\n                      <li>GET /insights/insightDetail/{insightName}</li></ul>",
      "readOnly": true,
      "example": "BILL_NOT_PAID"
    },
    "applicableConfiguration": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EligibleDetail"
      }
    }
  }
}