Skip to main content
Field Model V1 (FMV1) policies store custom field data in a segment-based structure. Each policy contains one or more segments, where each segment represents a time period and holds policy-level, coverage-level, and exposure-level custom field values.

​
Data Structure

FMV1 policies use a segments array where each segment contains:
  • segmentInfo — date range (start, end) for the segment
  • policy — policy-level custom field values (key-value pairs)
  • coverages — array of coverage objects with custom field values
  • exposures — array of exposure objects with custom field values
The field keys available for policy, coverages, and exposures are configured per company. Use the Configuration endpoint to discover available fields.

​
API Endpoints

MethodEndpointDescription
GET/v1/policiesList policies
POST/v1/policiesCreate a policy
GET/v1/policies/{policyId}Get a policy
DELETE/v1/policies/{policyId}Delete a policy
GET/v1/policies/configurationGet field configuration

​
Configuration

The configuration endpoint returns JSON Schemas for the custom fields:
  • policy schema — fields for segments[].policy and segments[].coverages[]
  • exposure schema — fields for segments[].exposures[]
Each schema includes field types, allowed enum values (for Option Set fields), and which fields are unconditionally required.

​
Permissions

OperationPermission
List, Get, Configurationcompany.policy:read
Create, Deletecompany.policy:create