Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
policies
/
configuration
Get Policy Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/configuration \
  --header 'Authorization: <api-key>'
{ "fields": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "policyName": { "type": "string", "title": "policyName" }, "policyPremium": { "type": "number", "title": "policyPremium", "readOnly": true, "x-calculated": true } }, "required": [ "policyName" ] } }

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey , and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Response

Configuration for the policy's fields

Configuration response for a Field Model V1 entity (Event, Exposure, Quote, Submission, Person, Organization, or read-only Policy). Returns a JSON Schema describing the fields available for creating or updating that entity. For entities that embed exposures (Quote), the embedded exposure schema is nested under the corresponding join field (e.g. exposures) rather than returned as a separate top-level key.

fields
object
required

Standard JSON Schema (draft 2020-12) describing field definitions for Field Model V1 entities. Includes a required array listing fields that must be provided.