Skip to main content
POST
/
api
/
external
/
companies
/
{companyId}
/
coverage-types
Create Coverage Type
curl --request POST \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "vfs_general_liability",
  "label": "General Liability"
}
'
{
  "id": "vfs_general_liability"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Body

application/json

Request to create a company-specific coverage type

​
key
string
required

Unique identifier for the coverage type. This is a human-readable string (not a UUID), typically following the convention {shortName}_{snake_case_name}.

Example:

"vfs_general_liability"

​
label
string
required

Display name for the coverage type

Example:

"General Liability"

Response

Coverage type created successfully

​
id
string

The ID of the created coverage type (same as the provided key)