Overview
Welcome to the AI Insurance External API documentation. This API allows you to programmatically manage your insurance operations, including submissions, quotes, policies, and more. Current API Resources:- Submissions - Create and manage insurance submissions
- Quotes - Generate and retrieve quote information
- Notes - Attach comments and documentation to entities
- Configuration - Access your company’s rating fields and coverage types
- Policies
- Events
- Insureds
- Financials
Getting Started
Base URL
All API endpoints are relative to your AI Insurance instance base URL:Authentication
All API requests require authentication using an API key. Include your API key in the request headers:To generate an API key, see Authentication.
API Resources
Submissions
Create and manage insurance submissions with complete policy and insured information.- List Submissions - Retrieve submissions for your company
- Create Submission - Create a new submission
- Update Submission - Update an existing submission
- Overview - Detailed guide on working with submissions
Quotes
Generate and retrieve quote information for submissions.- List Quotes (
GET /api/external/companies/{companyId}/quotes) - Retrieve complete quote details with all nested data - List Quote Info (
GET /api/external/companies/{companyId}/quotes-info) - Retrieve lightweight quote information (faster) - Get Quote (
GET /api/external/companies/{companyId}/quotes/{quoteId}) - Get detailed quote information by ID
Configuration
Access your company’s configuration including rating fields, coverage types, and entity types.- Get Configuration - Retrieve company configuration
Reference Documentation
Data Models
Complete reference for all data structures used in the API:- Submission Object - Submission response structure
- Quote Object (Lightweight) - Lightweight quote representation
- Quote Object (Full) - Complete quote structure
- ImportPolicy - Policy information for submissions
- ImportPolicyCoverage - Coverage data
- ImportInsured - Insured party information
