Envestnet · Schema

CoverageAmount

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
cover object
unitType string The type of coverage unit indicates if the coverage is for an individual or a family.

Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoint
type string The type of coverage provided to an individual or an entity.

Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:
  • GET account
limitType string The type of coverage limit indicates if the coverage is in-network or out-of-network.

Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoint
met object
View JSON Schema on GitHub

JSON Schema

envestnet-coverageamount-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CoverageAmount",
  "title": "CoverageAmount",
  "type": "object",
  "properties": {
    "cover": {
      "$ref": "#/components/schemas/Money"
    },
    "unitType": {
      "type": "string",
      "description": "The type of coverage unit indicates if the coverage is for an individual or a family.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance,investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values:</b><br>",
      "readOnly": true,
      "enum": [
        "PER_FAMILY",
        "PER_MEMBER"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of coverage provided to an individual or an entity.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance,investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values:</b><br>",
      "readOnly": true,
      "enum": [
        "DEDUCTIBLE",
        "OUT_OF_POCKET",
        "ANNUAL_BENEFIT",
        "MAX_BENEFIT",
        "COVERAGE_AMOUNT",
        "MONTHLY_BENEFIT",
        "OTHER"
      ]
    },
    "limitType": {
      "type": "string",
      "description": "The type of coverage limit indicates if the coverage is in-network or out-of-network.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance,investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values:</b><br>",
      "readOnly": true,
      "enum": [
        "IN_NETWORK",
        "OUT_NETWORK"
      ]
    },
    "met": {
      "$ref": "#/components/schemas/Money"
    }
  }
}