Get Exposure Configuration

Returns a JSON Schema describing the fields available for creating or updating Field Model V1 exposures.

The fields schema is a standard JSON Schema (draft 2020-12) that can be used directly with validation libraries like Ajv or Zod. The required array lists fields that must be provided when creating or updating an exposure.

Required permission: company.insured:read

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

Get Exposure Configuration

cURL

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

200

withCustomFields

{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "exposureName": {
        "type": "string",
        "title": "exposureName"
      },
      "exposureType": {
        "type": "string",
        "title": "exposureType"
      },
      "numberOfEmployees": {
        "type": "number",
        "title": "numberOfEmployees"
      },
      "riskLevel": {
        "type": "string",
        "title": "riskLevel",
        "oneOf": [
          {
            "const": "low",
            "title": "Low"
          },
          {
            "const": "medium",
            "title": "Medium"
          },
          {
            "const": "high",
            "title": "High"
          }
        ]
      }
    },
    "required": [
      "exposureName",
      "exposureType"
    ]
  }
}

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 exposure fields

Configuration response for Field Model V1 exposures. Returns a JSON Schema describing the fields available for creating or updating exposures.

fields · object · required

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

Show child attributes