Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
v1
/
exposures
/
configuration
Get Exposure Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/v1/exposures/configuration \
  --header 'Authorization: <api-key>'
{
  "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",
        "enum": [
          "Low",
          "Medium",
          "High"
        ]
      }
    },
    "required": [
      "exposureName",
      "exposureType"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Response

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.