Get Quotes Configuration

Returns JSON Schemas describing the custom fields available for Field Model V1 quotes. 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 fields used in the quote’s policy object. The exposure schema covers fields used in the exposures[] array.

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

Required permission: company.quote:read

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

Get Quotes Configuration

cURL

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/quotes/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"
          }
        ]
      }
    },
    "required": [
      "effectiveDate"
    ]
  },
  "exposure": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "exposureName": {
        "type": "string",
        "title": "exposureName"
      },
      "employeeCount": {
        "type": "number",
        "title": "employeeCount"
      }
    },
    "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 quote custom fields

Configuration response for Field Model V1 quotes. Returns JSON Schemas describing the policy-level and exposure-level fields available for creating or updating quotes. Lifecycle fields (quoteType, quoteStatus, quoteNumber, quoteBindErrors, quoteSubmissionId) are omitted.

policy · object · required

JSON Schema (draft 2020-12) describing the valid policy-level fields. Each property corresponds to a field referenceId in the company's configuration.

Show child attributes

exposure · object · required

JSON Schema (draft 2020-12) describing the valid exposure-level fields.

Show child attributes