Overview

The Insureds API allows you to manage insured entities (exposures) for your company. Insureds represent the individuals or organizations that are covered by insurance policies.

Key Concepts:

• Insureds are entities (individuals or organizations) covered by insurance policies
• Each insured has a name and entityType that classify them
• Insureds can be associated with policies and events
• Deleting an insured performs a soft delete (the record is marked as deleted but retained)

---

API Endpoints

• List Insureds - Retrieve paginated list of insureds with filtering and sorting
• Create Insured - Create a new insured
• Update Insured - Update an existing insured
• Delete Insured - Soft delete an insured by ID

---

Insured Fields

Field	Type	Required	Description
id	uuid	-	Insured identifier (returned in responses)
name	string	Yes	Name of the insured
entityType	string	Yes	Entity type (e.g., “individual”, “organization”, “dealership”)
email	string	No	Insured email address
phoneNumber	string	No	Insured phone number
billingEmail	string	No	Billing email address
defaultBrokerId	uuid	No	Default broker ID for this insured
policyIds	uuid[]	-	IDs of associated policies (returned in list responses)
createdAt	datetime	-	When the insured was created

---

Filtering and Sorting (List)

Filter Parameters

Parameter	Type	Description
id	uuid or uuid[]	Filter by insured ID (single or array)
entityType	string	Filter by entity type
filterText	string	Text search across insured name

Sorting Parameters

Parameter	Type	Default	Description
sortBy	string	createdAt	Field to sort by (createdAt, name, entityType)
sortDirection	string	desc	Sort direction (asc or desc)

---

Permissions

Access to insureds requires the appropriate permissions based on your API key:

Operation	Required Permission
List Insureds	company.insured:read
Create Insured	company.insured:create
Update Insured	insured:update
Delete Insured	insured:delete

---

Example List Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440200",
      "name": "John Smith",
      "entityType": "individual",
      "policyIds": ["550e8400-e29b-41d4-a716-446655440100"],
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "totalCount": 1
}

Example Create Request

{
  "name": "Acme Manufacturing GmbH",
  "entityType": "organization"
}

Example Create Response

{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

Example Update Request

{
  "name": "John Smith Jr.",
  "email": "[e-mail]"
}

Example Update Response

{
  "id": "550e8400-e29b-41d4-a716-446655440200",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "John Smith Jr.",
  "entityType": "individual",
  "phoneNumber": null,
  "email": "[e-mail]",
  "billingEmail": null,
  "defaultBrokerId": null,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "google-oauth2|123456789",
  "updatedAt": "2025-01-20T14:00:00.000Z",
  "updatedBy": "google-oauth2|987654321"
}

Example Delete Response

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "deleted": true
}

---