Skip to main content

​
Overview

Coverage types represent the lines of coverage a company offers, such as General Liability, Workers Compensation, or Auto. Each coverage type has a set of fields that determine what data can be recorded on events (claims and incidents) of that type. There are two kinds of coverage types:
  • Global coverage types (e.g., general_liability, inland_marine) are shared across all companies and cannot be created or deleted via the API.
  • Company-specific coverage types are created and owned by a single company.
Use the Coverage Types API to list all available coverage types (global and company-specific), create company-specific coverage types, control which types are active for a company, discover which fields are available for each coverage type, or set the fields on company-specific coverage types.

​
API Endpoints

​
Example: Create a Coverage Type

POST /api/external/companies/{companyId}/coverage-types

{
  "key": "vfs_general_liability",
  "label": "General Liability"
}
Response: 
{
  "id": "vfs_general_liability"
}

​
Example: Get Coverage Type Fields

GET /api/external/companies/{companyId}/coverage-types/general_liability/fields

{
  "coverageTypeId": "general_liability",
  "coverageTypeName": "General Liability",
  "fields": [
    "reportDate",
    "eventDescription",
    "settlementDemand",
    "indemnityPaid",
    "alaeReserveAmount"
  ],
  "metadata": {
    "coverageTypeScope": "global",
    "fieldSources": ["database", "static"]
  }
}