Skip to main content

Overview

This document describes the REST API endpoints for managing submissions and their associated quotes in the AI Insurance platform.

Base URL

All endpoints are relative to your AI Insurance instance base URL.

Authentication

API requests require proper authentication. Include your API key in the request headers:
Authorization: ApiKey YOUR-API-KEY
To generate an API key, see Generating API Keys.

Common Response Patterns

Error Responses

All endpoints may return the following error responses:
  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Missing or invalid authentication
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Resource not found
  • 500 Internal Server Error - Server error

API Endpoints

Submissions API

Quotes API

Configuration

  • Get Configuration - Retrieve company configuration including rating fields, entity types, and coverage options

Data Models

  • Data Models - Complete reference for all data structures used in the API

Testing the API

You can test the API endpoints using the interactive documentation or with tools like cURL.

Example: Testing Get Configuration

  1. Click on “Get Configuration” in the sidebar
  2. Copy and paste the cURL code into your terminal or API client
  3. Replace the <YOUR-COMPANY-ID> parameter with your Company ID
    For instructions to find your Company ID, see Generating API Keys
  4. Run the code
  5. Your company’s configuration data will be returned as the response.

Example cURL Request

curl -X GET \
  "https://app.aiinsurance.io/api/external/companies/EXAMPLE-COMPANY/configuration" \
  -H "Authorization: ApiKey EXAMPLE-API-KEY-123456"

Data Models Reference

The API uses several data models for requests and responses: Each endpoint documentation includes links to the relevant data models for detailed field descriptions.

Status Values

Submission Status Values

  • draft - Submission is being prepared
  • submitted - Submission has been submitted for review
  • under_review - Submission is being reviewed
  • quoted - Quote has been generated
  • bound - Policy has been bound
  • declined - Submission was declined

Submission Types

  • new_business - New business submission
  • renewal - Policy renewal submission
  • endorsement - Policy endorsement submission

Quote Status Values

  • draft - Quote is being prepared
  • active - Quote is active and available
  • expired - Quote has expired
  • bound - Quote has been bound to a policy
  • declined - Quote was declined
  • superseded - Quote has been replaced by a newer version

Policy Type Options

CodeDescription
CClaims Made
NClaims Made “Nose” (Prior Acts)
TClaims Made “Tail” (Reporting Endorsement)
OOccurrence
PClaims Paid
SSlot Coverage - Claims Made
QSlot Coverage “Tail” (Reporting Endorsement)
RSlot Coverage - Occurrence

Changelog

Version 0.1.0 (Alpha) - 8/8/2025

  • Support for submission creation
  • Support for submission update (adding a quote to an existing submission)
  • Support for retrieving company configuration

Version 0.0.0 (Alpha)

  • Initial API documentation
  • Support for submissions and quotes listing
  • API Key authentication
I