Get Policies Configuration

Returns JSON Schemas describing the custom fields available for Field Model V1 policies. The response contains separate schemas for policy-level fields and exposure-level fields.

Each schema is a standard JSON Schema (draft 2020-12) that can be used directly with validation libraries like Ajv or Zod.

The policy schema covers policy-level custom fields (used in policy fieldModelV1Data.policy or segment policy objects). The exposure schema covers exposure-level custom fields.

Lifecycle fields (quoteType, quoteStatus, quoteNumber, quoteBindErrors, quoteSubmissionId) are omitted from the configuration since they are system-managed.

Required permission: company.policy:read

GET /api/v1/external/companies/{companyId}/policies/configuration

Get Policies Configuration

cURL

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/configuration \
  --header 'Authorization: <api-key>'

200

withCustomFields

{
  "policy": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "effectiveDate": {
        "type": "string",
        "title": "effectiveDate"
      },
      "premium": {
        "type": "number",
        "title": "premium"
      },
      "status": {
        "type": "string",
        "title": "status",
        "oneOf": [
          {
            "const": "active",
            "title": "Active"
          },
          {
            "const": "cancelled",
            "title": "Cancelled"
          },
          {
            "const": "expired",
            "title": "Expired"
          }
        ]
      }
    },
    "required": [
      "effectiveDate"
    ]
  },
  "exposure": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "employeeCount": {
        "type": "number",
        "title": "employeeCount"
      },
      "isActive": {
        "type": "boolean",
        "title": "isActive"
      }
    },
    "required": []
  }
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

Response

200

application/json

Configuration for FMV1 policy custom fields

Configuration response for Field Model V1 policies. Returns separate JSON Schemas for policy-level and exposure-level custom fields.

policy · object · required

JSON Schema for policy-level custom fields. These fields apply to segments[].policy objects (including policyCoverages).

Show child attributes

exposure · object · required

JSON Schema for exposure-level custom fields. These fields apply to segments[].exposures[] objects.

Show child attributes