# AI Insurance ## Docs - [FAQs](https://docs.aiinsurance.io/FAQs/FAQs.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/assignees/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/attorneys/overview.md) - [Generating API Keys](https://docs.aiinsurance.io/api-legacy-reference/authentication.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/brokerages/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/brokers/overview.md) - [API Changelog](https://docs.aiinsurance.io/api-legacy-reference/changelog.md): Track updates and improvements to the AI Insurance API - [Get Configuration](https://docs.aiinsurance.io/api-legacy-reference/configuration.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-fields/overview.md): Manage entity field definitions for your company - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-presets/overview.md): Manage coverage limit presets for your company - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-rating-fields/overview.md): Manage rating engine input field definitions for your company - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-rating-form-logic/overview.md): Manage form-attachment rules in rating engine revision config - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-rating-outputs/overview.md): Manage rating output field definitions for your company - [Overview](https://docs.aiinsurance.io/api-legacy-reference/configuration-rating-presets/overview.md): Manage coverage limit presets in rating engine revision config - [Overview](https://docs.aiinsurance.io/api-legacy-reference/coverage-types/overview.md): Create, manage, and query coverage types and their fields - [Data Models](https://docs.aiinsurance.io/api-legacy-reference/data-models.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/defendants/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/event-financials/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/events/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/exposure-types/overview.md): Manage exposure type definitions for your company - [Overview](https://docs.aiinsurance.io/api-legacy-reference/exposure/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/lawsuits/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/notes/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/payees/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/policies/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/quotes/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/smart-tags/overview.md): Retrieve smart tags for categorizing and labeling entities - [Overview](https://docs.aiinsurance.io/api-legacy-reference/submissions/overview.md) - [Overview](https://docs.aiinsurance.io/api-legacy-reference/transaction-categories/overview.md): Retrieve available transaction categories for financial transactions - [Resolve Address](https://docs.aiinsurance.io/api-reference/address/resolve-address.md): Geocodes a freeform address string and returns the structured subfields (`street`, `city`, `state`, `county`, `country`, `zipCode`) in the shape Field Model V1 rating expects. - [List Assignees](https://docs.aiinsurance.io/api-reference/assignees/list-assignees.md): Returns the list of users assigned to a specific entity. - [Set Assignees](https://docs.aiinsurance.io/api-reference/assignees/set-assignees.md): Sets the assignees for a specific entity. This is a full replacement — the provided list of user IDs completely replaces any existing assignees. Pass an empty array to remove all assignees. - [Create Attorney](https://docs.aiinsurance.io/api-reference/attorneys/create-attorney.md): Creates a new attorney. - [Delete Attorney](https://docs.aiinsurance.io/api-reference/attorneys/delete-attorney.md): Soft deletes an attorney by setting deletedAt and deletedBy timestamps. The attorney will no longer be returned in list or get operations. - [Get Attorney](https://docs.aiinsurance.io/api-reference/attorneys/get-attorney.md): Returns a single attorney by ID. - [List Attorneys](https://docs.aiinsurance.io/api-reference/attorneys/list-attorneys.md): Returns a paginated list of attorneys for the company. - [Update Attorney](https://docs.aiinsurance.io/api-reference/attorneys/update-attorney.md): Updates an existing attorney. Only send fields you want to change. Send `null` for nullable fields to clear them. - [Bind Quote](https://docs.aiinsurance.io/api-reference/basic-policies/bind-quote.md): Binds a Field Model V1 quote, creating a Basic Policy. The quote must not already be bound. - [Create Basic Policy](https://docs.aiinsurance.io/api-reference/basic-policies/create-basic-policy.md): Creates a new basic policy. The request body is a flat object of company-configured fields plus a nested `exposures` array. - [Delete Basic Policy](https://docs.aiinsurance.io/api-reference/basic-policies/delete-basic-policy.md): Soft-deletes a basic policy. - [Get Basic Policy](https://docs.aiinsurance.io/api-reference/basic-policies/get-basic-policy.md): Returns a single basic policy by ID, with the flat `fieldModelV1Data` object including the nested `exposures` array. - [List Basic Policies](https://docs.aiinsurance.io/api-reference/basic-policies/list-basic-policies.md): Returns a paginated list of basic policies for the company. - [Create Brokerage](https://docs.aiinsurance.io/api-reference/brokerages/create-brokerage.md): Creates a new brokerage. - [Delete Brokerage](https://docs.aiinsurance.io/api-reference/brokerages/delete-brokerage.md): Soft deletes a brokerage by setting deletedAt and deletedBy timestamps. The brokerage will no longer be returned in list or get operations. - [Get Brokerage](https://docs.aiinsurance.io/api-reference/brokerages/get-brokerage.md): Returns a single brokerage by ID. - [List Brokerages](https://docs.aiinsurance.io/api-reference/brokerages/list-brokerages.md): Returns a paginated list of brokerages for the company. - [Update Brokerage](https://docs.aiinsurance.io/api-reference/brokerages/update-brokerage.md): Updates an existing brokerage. Only send fields you want to change. - [Create Broker](https://docs.aiinsurance.io/api-reference/brokers/create-broker.md): Creates a new broker associated with an existing brokerage. - [Delete Broker](https://docs.aiinsurance.io/api-reference/brokers/delete-broker.md): Soft deletes a broker by setting deletedAt and deletedBy timestamps. The broker will no longer be returned in list or get operations. - [Get Broker](https://docs.aiinsurance.io/api-reference/brokers/get-broker.md): Returns a single broker by ID. - [List Brokers](https://docs.aiinsurance.io/api-reference/brokers/list-brokers.md): Returns a paginated list of brokers for the company. - [Update Broker](https://docs.aiinsurance.io/api-reference/brokers/update-broker.md): Updates an existing broker. Only send fields you want to change. - [Create Configuration Field](https://docs.aiinsurance.io/api-reference/configuration-fields/create-configuration-field.md): Creates a new configuration field and associates it with the specified entity type. - [Delete Configuration Field](https://docs.aiinsurance.io/api-reference/configuration-fields/delete-configuration-field.md): Deletes a configuration field by ID. The field must be an entity field (events, insureds, or policies) — rating fields cannot be deleted through this endpoint. - [List Configuration Fields](https://docs.aiinsurance.io/api-reference/configuration-fields/list-configuration-fields.md): Returns a paginated list of configuration fields for the company. Only returns entity fields (events, insureds, policies) — rating fields are managed through separate endpoints. - [Create Configuration Preset](https://docs.aiinsurance.io/api-reference/configuration-presets/create-configuration-preset.md): Creates a new coverage limit preset for the company. The preset is stored directly in the `coverage_limit_presets` table. - [Delete Configuration Preset](https://docs.aiinsurance.io/api-reference/configuration-presets/delete-configuration-preset.md): Soft-deletes a coverage limit preset by ID. The preset is marked as deleted and will no longer appear in list results, but is not physically removed from the database. - [List Configuration Presets](https://docs.aiinsurance.io/api-reference/configuration-presets/list-configuration-presets.md): Returns a paginated list of coverage limit presets for the company. - [Create Configuration Rating Field](https://docs.aiinsurance.io/api-reference/configuration-rating-fields/create-configuration-rating-field.md): Creates a new rating input field and associates it with the specified entity type and rating engine revision. - [Delete Configuration Rating Field](https://docs.aiinsurance.io/api-reference/configuration-rating-fields/delete-configuration-rating-field.md): Deletes a rating input field by ID. The field definition, its application field association, and its entry in the rating engine revision's `config.applicationFields` are all permanently removed. - [List Configuration Rating Fields](https://docs.aiinsurance.io/api-reference/configuration-rating-fields/list-configuration-rating-fields.md): Returns a paginated list of rating input fields for the company. Only returns rating fields — entity fields (events, insureds, policies) are managed through `/configuration/fields` endpoints. - [Reorder Configuration Rating Fields](https://docs.aiinsurance.io/api-reference/configuration-rating-fields/reorder-configuration-rating-fields.md): Reorders the rating input fields for a single `(companyId, entityType)` tuple by rewriting `application_fields.rank`. The array index of each field id in the request becomes its new `rank` (lower renders first, `null` renders last). - [Create Rating Revision Form Logic](https://docs.aiinsurance.io/api-reference/configuration-rating-form-logic/create-rating-revision-form-logic.md): Creates a new form-logic rule in the rating engine revision's config JSON (`rating_engine_revisions.config.policyFormLogicConfigs`). Rules determine which forms are attached to policies or quotes based on a `shouldAdd` expression evaluated during rating. - [Delete Rating Revision Form Logic](https://docs.aiinsurance.io/api-reference/configuration-rating-form-logic/delete-rating-revision-form-logic.md): Removes a form-logic rule from the rating engine revision's config JSON by ID. The rule is permanently removed from the `policyFormLogicConfigs` array in the revision's config. - [List Rating Revision Form Logic](https://docs.aiinsurance.io/api-reference/configuration-rating-form-logic/list-rating-revision-form-logic.md): Returns all form-logic rules from a rating engine revision's config JSON (`config.policyFormLogicConfigs`). Rules are returned as a flat list with no pagination. - [Create Configuration Rating Output](https://docs.aiinsurance.io/api-reference/configuration-rating-outputs/create-configuration-rating-output.md): Creates a new rating output field (entity name: `rating_engine_display`) and an associated smart tag with the naming convention `AII{key}PrimaryInsured`. - [Delete Configuration Rating Output](https://docs.aiinsurance.io/api-reference/configuration-rating-outputs/delete-configuration-rating-output.md): Deletes a rating output field by ID. The field definition, its `company_entity_fields` association, and its associated smart tag are all removed. The field and association are permanently deleted; the smart tag is soft-deleted (`deleted_at` is set). - [List Configuration Rating Outputs](https://docs.aiinsurance.io/api-reference/configuration-rating-outputs/list-configuration-rating-outputs.md): Returns a paginated list of rating output fields (`rating_engine_display`) for the company. - [Create Rating Revision Preset](https://docs.aiinsurance.io/api-reference/configuration-rating-presets/create-rating-revision-preset.md): Creates a new coverage limit preset in the rating engine revision's config JSON. This endpoint is for **rating-engine companies** — presets are stored in `rating_engine_revisions.config.coverageLimitPresets`, not in the `coverage_limit_presets` table. - [Delete Rating Revision Preset](https://docs.aiinsurance.io/api-reference/configuration-rating-presets/delete-rating-revision-preset.md): Removes a coverage limit preset from the rating engine revision's config JSON by ID. The preset is permanently removed from the `coverageLimitPresets` array in the revision's config. - [List Rating Revision Presets](https://docs.aiinsurance.io/api-reference/configuration-rating-presets/list-rating-revision-presets.md): Returns all coverage limit presets from a rating engine revision's config JSON (`config.coverageLimitPresets`). This endpoint is for **rating-engine companies**. - [Create Coverage Type](https://docs.aiinsurance.io/api-reference/coverage-types/create-coverage-type.md): Creates a new company-specific coverage type. The coverage type is inserted into the `coverage_types` table with `company_identifier` set to the company ID. - [Delete Coverage Type](https://docs.aiinsurance.io/api-reference/coverage-types/delete-coverage-type.md): Permanently deletes a company-specific coverage type. Global coverage types cannot be deleted. - [Get Coverage Type Fields](https://docs.aiinsurance.io/api-reference/coverage-types/get-coverage-type-fields.md): Returns the list of field keys associated with a given coverage type. - [List Coverage Types](https://docs.aiinsurance.io/api-reference/coverage-types/list-coverage-types.md): Returns all coverage types available to the company, including both global types and company-specific types. Results are sorted alphabetically by key. - [Set Coverage Type Fields](https://docs.aiinsurance.io/api-reference/coverage-types/set-coverage-type-fields.md): Sets the fields associated with a company-specific coverage type. - [Set Enabled Coverage Types](https://docs.aiinsurance.io/api-reference/coverage-types/set-enabled-coverage-types.md): Replaces the company's enabled coverage types list wholesale. The provided `coverageTypeKeys` array becomes the new complete list of enabled coverage types for the company. - [Create Defendant](https://docs.aiinsurance.io/api-reference/defendants/create-defendant.md): Creates a defendant for a lawsuit. A lawsuit must exist for the given event. - [Delete Defendant](https://docs.aiinsurance.io/api-reference/defendants/delete-defendant.md): Soft-deletes a defendant. The defendant will no longer be returned by GET or LIST requests. - [Get Defendant](https://docs.aiinsurance.io/api-reference/defendants/get-defendant.md): Returns a single defendant by ID. - [List Defendants](https://docs.aiinsurance.io/api-reference/defendants/list-defendants.md): Returns a paginated list of defendants for a lawsuit. - [Update Defendant](https://docs.aiinsurance.io/api-reference/defendants/update-defendant.md): Updates a defendant. Only provided fields are updated. Send `null` for a field to clear its value. Omit a field to preserve its existing value. - [Create Event Transaction](https://docs.aiinsurance.io/api-reference/event-financials/create-event-transaction.md): Creates a new financial transaction for an event. - [Delete Event Transaction](https://docs.aiinsurance.io/api-reference/event-financials/delete-event-transaction.md): Permanently soft-deletes a financial transaction. Unlike voiding, deletion is for transactions that should not have existed at all. Sets `deletedAt` and `deletedBy` on the transaction and recalculates reserves. - [Get Event Reserves](https://docs.aiinsurance.io/api-reference/event-financials/get-event-reserves.md): Returns reserve information for all transaction categories on an event. - [Get Event Transaction](https://docs.aiinsurance.io/api-reference/event-financials/get-event-transaction.md): Returns a single financial transaction by ID, including line items (itemizations). - [Get Event Transaction Totals](https://docs.aiinsurance.io/api-reference/event-financials/get-event-transaction-totals.md): Returns transaction totals for all expense categories on a specific event. - [List Event Financial Totals](https://docs.aiinsurance.io/api-reference/event-financials/list-event-financial-totals.md): Returns a paginated list of all events with their financial totals for a specific transaction type. - [List Event Transactions](https://docs.aiinsurance.io/api-reference/event-financials/list-event-transactions.md): Returns a paginated list of financial transactions for a specific event. - [List Expected Total Timeline](https://docs.aiinsurance.io/api-reference/event-financials/list-expected-total-timeline.md): Returns a chronological timeline of expected total (reserve) changes for specified events. - [Update Expected Totals](https://docs.aiinsurance.io/api-reference/event-financials/update-expected-totals.md): Updates the expected total for a transaction category on an event. - [Void Event Transaction](https://docs.aiinsurance.io/api-reference/event-financials/void-event-transaction.md): Voids a financial transaction. Once voided, a transaction cannot be modified further. Optionally provide a custom void reason. - [Create Event](https://docs.aiinsurance.io/api-reference/events/create-event.md): Creates a new event (claim or incident). - [Delete Event](https://docs.aiinsurance.io/api-reference/events/delete-event.md): Soft deletes an event by setting deletedAt and deletedBy timestamps. The event will no longer be returned in list or get operations. - [Get Event](https://docs.aiinsurance.io/api-reference/events/get-event.md): Returns a single event by ID. - [Get Events Configuration](https://docs.aiinsurance.io/api-reference/events/get-events-configuration.md): Returns a JSON Schema describing the custom fields available for the `data` object when creating or updating events, along with mappings that indicate which fields apply to which coverage types. - [List Events](https://docs.aiinsurance.io/api-reference/events/list-events.md): Returns a paginated list of events (claims and incidents) for the company. - [Update Event](https://docs.aiinsurance.io/api-reference/events/update-event.md): Updates an existing event. Only send fields you want to change. - [Create Exposure Type](https://docs.aiinsurance.io/api-reference/exposure-types/create-exposure-type.md): Creates a new exposure type for the company and adds it to the company's enabled exposure types. - [Delete Exposure Type](https://docs.aiinsurance.io/api-reference/exposure-types/delete-exposure-type.md): Permanently deletes a company-specific exposure type and removes it from the company's enabled exposure types. - [List Exposure Types](https://docs.aiinsurance.io/api-reference/exposure-types/list-exposure-types.md): Returns all exposure types configured for the company. Results are sorted alphabetically by key. - [Create Exposure](https://docs.aiinsurance.io/api-reference/exposures/create-exposure.md): Creates a new exposure for the company. - [Delete Exposure](https://docs.aiinsurance.io/api-reference/exposures/delete-exposure.md): Soft deletes an exposure by ID. - [Get Exposure](https://docs.aiinsurance.io/api-reference/exposures/get-exposure.md): Returns a single exposure by ID. - [List Exposures](https://docs.aiinsurance.io/api-reference/exposures/list-exposures.md): Returns a paginated list of exposures for the company. - [Update Exposure](https://docs.aiinsurance.io/api-reference/exposures/update-exposure.md): Updates an existing exposure. - [Download Bordereau CSV](https://docs.aiinsurance.io/api-reference/field-model-bordereau/download-bordereau-csv.md): Downloads the bordereau report as a CSV file. Returns the same transaction-level premium data as the [List Bordereau Rows](/api-reference/field-model/bordereau/list) endpoint, serialized as RFC 4180 CSV with a `Content-Disposition: attachment` header. - [Export Bordereau to Google Sheets](https://docs.aiinsurance.io/api-reference/field-model-bordereau/export-bordereau-to-google-sheets.md): Exports the bordereau report to a Google Sheets spreadsheet. Writes the same transaction-level premium data as the [List Bordereau Rows](/api-reference/field-model/bordereau/list) endpoint into a Google Sheets tab. - [List Bordereau Rows](https://docs.aiinsurance.io/api-reference/field-model-bordereau/list-bordereau-rows.md): Returns a paginated, flat list of transaction-level premium rows (a "bordereau"). Each row represents one policy transaction and includes fixed columns (policy number, insured name, action, dates, premium, premium change) plus optional dynamic columns resolved from FullTerm custom object fields. - [Add Custom Object Relationship](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/add-custom-object-relationship.md): Links a custom object to a target entity via a relationship field. Use the `fieldRefId` from the [Get Configuration](/api-reference/field-model/custom-objects/get-custom-object-configuration) endpoint. - [Create Custom Object](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/create-custom-object.md): Creates a new custom object of the given type. - [Delete Custom Object](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/delete-custom-object.md): Deletes a custom object by ID. - [Get Custom Object](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/get-custom-object.md): Returns a single custom object by ID. The response includes both `data` (regular field values) and `relationships` (linked entity IDs). - [Get Custom Object Configuration](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/get-custom-object-configuration.md): Returns the field configuration for a custom object type. The response includes: - [List Custom Object Types](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/list-custom-object-types.md): Returns the list of custom object types configured for the company. Use the `type` value from the response as the `objectType` path parameter for all other custom object endpoints. - [List Custom Objects](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/list-custom-objects.md): Returns a paginated list of custom objects for the given type. - [Remove Custom Object Relationship](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/remove-custom-object-relationship.md): Removes the link between a custom object and a target entity for the given relationship field. - [Update Custom Object](https://docs.aiinsurance.io/api-reference/field-model-custom-objects/update-custom-object.md): Updates a custom object's data fields. The request body must include a `data` object — this is a **full replacement** of the object's field data, not a merge. Include all fields you want the object to have after the update. - [Aggregate Earned Premium](https://docs.aiinsurance.io/api-reference/field-model-earned-premium/aggregate-earned-premium.md): Returns earned premium per day summed across all matching policies. No per-policy or per-transaction breakdown — just a daily time series and a grand total. - [Get Earned Premium (Single Policy)](https://docs.aiinsurance.io/api-reference/field-model-earned-premium/get-earned-premium-single-policy.md): Returns earned premium for a single policy over a date range. Each transaction on the policy produces a daily contribution (a fixed daily rate over its effective range), and the earned premium on any given day is the sum of all active contributions. - [List Earned Premium (Multi-Policy)](https://docs.aiinsurance.io/api-reference/field-model-earned-premium/list-earned-premium-multi-policy.md): Returns earned premium for multiple policies, paginated by policy. Each item in the response has the same shape as the single-policy endpoint for the requested detail level. - [Create Event](https://docs.aiinsurance.io/api-reference/field-model-events/create-event.md): Creates a new Field Model V1 event for the company. - [Delete Event](https://docs.aiinsurance.io/api-reference/field-model-events/delete-event.md): Deletes a Field Model V1 event by ID. - [Get Event](https://docs.aiinsurance.io/api-reference/field-model-events/get-event.md): Returns a single Field Model V1 event by ID. - [Get Event Configuration](https://docs.aiinsurance.io/api-reference/field-model-events/get-event-configuration.md): Returns a JSON Schema describing the fields available for creating or updating Field Model V1 events. - [List Events](https://docs.aiinsurance.io/api-reference/field-model-events/list-events.md): Returns a paginated list of Field Model V1 events for the company. - [Update Event](https://docs.aiinsurance.io/api-reference/field-model-events/update-event.md): Updates a Field Model V1 event. The request body is a flat JSON object with field `referenceId`s as keys — the same shape as the create request. - [Create Exposure](https://docs.aiinsurance.io/api-reference/field-model-exposures/create-exposure.md): Creates a new Field Model V1 exposure for the company. - [Delete Exposure](https://docs.aiinsurance.io/api-reference/field-model-exposures/delete-exposure.md): Soft deletes a Field Model V1 exposure by ID. - [Get Exposure](https://docs.aiinsurance.io/api-reference/field-model-exposures/get-exposure.md): Returns a single Field Model V1 exposure by ID. - [Get Exposure Configuration](https://docs.aiinsurance.io/api-reference/field-model-exposures/get-exposure-configuration.md): Returns a JSON Schema describing the fields available for creating or updating Field Model V1 exposures. - [List Exposures](https://docs.aiinsurance.io/api-reference/field-model-exposures/list-exposures.md): Returns a paginated list of Field Model V1 exposures for the company. - [Update Exposure](https://docs.aiinsurance.io/api-reference/field-model-exposures/update-exposure.md): Updates a Field Model V1 exposure. The request body is a flat JSON object with field `referenceId`s as keys — the same shape as the create request. - [Get Policies Configuration](https://docs.aiinsurance.io/api-reference/field-model-policies/get-policies-configuration.md): Returns JSON Schemas describing the custom fields available for Field Model V1 policies. The response contains separate schemas for policy-level fields and exposure-level fields. - [Cancel Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/cancel-policy-transaction.md): Cancels a policy as of a given date via a CANCEL transaction. The policy must be Active at the cancellation date. The action sets `policyStatus` to `cancelled` from the cancellation date through the end of the policy term and records a `policyEarlyTerminationDate` on `fullTermPolicyInfo`. - [Delete Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/delete-policy-transaction.md): Deletes the most recent transaction on a policy, rolling the policy back to its prior version. Only the most recent transaction (highest `policyVersion`) can be deleted — attempting to delete an older transaction returns a 400 error. - [Endorse Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/endorse-policy-transaction.md): Applies an ENDORSE transaction to an existing policy. Endorsements modify policy state over specified date ranges using per-field deltas. Each delta targets a specific path within the policy data (e.g. `policy.annualPremium`, `policy.exposures`) and can Add, Remove, or Overwrite values. - [Get Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/get-policy-transaction.md): Returns a single policy transaction by ID, including its per-field deltas. Each delta describes a specific field change (add, remove, or overwrite) within a date range. - [Get Policy Version](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/get-policy-version.md): Returns a specific version of a policy with all its derived segments. - [List Policies](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/list-policies.md): Returns a paginated list of policies, resolving each policy to its latest version (or the latest version as of `timeTravelBackToDate`), then applying segment scope filters and field-level JSONB filters. - [List Policy Transactions](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/list-policy-transactions.md): Returns a paginated list of all transactions for a policy, ordered by `policyVersion`. Each transaction represents an immutable change set (new business, endorsement, cancellation, reinstatement, or renewal). - [List Policy Versions](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/list-policy-versions.md): Lists policy versions across all policies. Unlike "List Policies" (which resolves each policy to one version), this endpoint returns every `(policy, version)` pair that matches the filters. A single policy can appear multiple times if multiple versions match. - [List Single Policy Versions](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/list-single-policy-versions.md): Returns a paginated list of all versions for a single policy. Each version is a snapshot of the policy state produced by a transaction. Use this to see how a policy changed over time, or to find versions that match specific field criteria. - [New Business Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/new-business-transaction.md): Creates a new policy via a NEW_BUSINESS transaction. This is the entry point for the transaction-based policy lifecycle. The transaction produces a single segment covering the full policy term. - [Reinstate Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/reinstate-policy-transaction.md): Reinstates a previously cancelled policy as of a given date via a REINSTATE transaction. The policy must be Cancelled at the reinstatement date. The action sets `policyStatus` back to `active` from the reinstatement date through the end of the policy term and clears the `policyEarlyTerminationDate`… - [Renew Policy Transaction](https://docs.aiinsurance.io/api-reference/field-model-policy-transactions/renew-policy-transaction.md): Creates a new policy via a RENEW transaction, linking it to a previous policy. The new policy term must start on or after the previous policy's end date. - [Validate Policies (Batch)](https://docs.aiinsurance.io/api-reference/field-model-policy-validation/validate-policies-batch.md): Runs data consistency checks against multiple policies in a single request and returns paginated results. This is a read-only diagnostic endpoint — no data is modified. - [Validate Policy](https://docs.aiinsurance.io/api-reference/field-model-policy-validation/validate-policy.md): Runs data consistency checks against a single policy and returns detailed results. This is a read-only diagnostic endpoint — no data is modified. - [Create Quote](https://docs.aiinsurance.io/api-reference/field-model-quotes/create-quote.md): Creates a new Field Model V1 quote. - [Delete Quote](https://docs.aiinsurance.io/api-reference/field-model-quotes/delete-quote.md): Soft-deletes a Field Model V1 quote. - [Get Quote](https://docs.aiinsurance.io/api-reference/field-model-quotes/get-quote.md): Returns a single Field Model V1 quote by ID, including policy and exposure data. - [Get Quotes Configuration](https://docs.aiinsurance.io/api-reference/field-model-quotes/get-quotes-configuration.md): Returns JSON Schemas describing the custom fields available for Field Model V1 quotes. The response contains separate schemas for policy-level fields and exposure-level fields. - [List Quotes](https://docs.aiinsurance.io/api-reference/field-model-quotes/list-quotes.md): Returns a paginated list of Field Model V1 quotes for the company. - [Send Quote](https://docs.aiinsurance.io/api-reference/field-model-quotes/send-quote.md): Sends a Field Model V1 quote, transitioning its status to "sent". - [Update Quote](https://docs.aiinsurance.io/api-reference/field-model-quotes/update-quote.md): Updates a Field Model V1 quote. This is a **full replacement** of the quote's policy and exposure data. - [Compare Configuration](https://docs.aiinsurance.io/api-reference/fmv1-configuration/compare-configuration.md): Compares an FMV1 configuration spreadsheet against the current database state and returns a diff summary. Each configuration category (field definitions, option sets, custom objects, etc.) includes counts of additions, updates, deletes, and unchanged items. - [Export Configuration](https://docs.aiinsurance.io/api-reference/fmv1-configuration/export-configuration.md): Exports the company's FMV1 configuration to an existing Google Spreadsheet. The spreadsheet is overwritten with the current configuration including field definitions, option sets, custom objects, card definitions, card sections, and field locations. - [Generate Configuration Spreadsheet](https://docs.aiinsurance.io/api-reference/fmv1-configuration/generate-configuration-spreadsheet.md): Creates a new Google Spreadsheet with the FMV1 configuration template structure. The spreadsheet contains all the required sheets, headers, and formatting but no data — it is a blank template ready to be filled in. - [Import Configuration](https://docs.aiinsurance.io/api-reference/fmv1-configuration/import-configuration.md): Imports FMV1 configuration from a Google Spreadsheet into the database. This runs the full pipeline: validate, parse, compare, and apply changes. - [Validate Configuration Spreadsheet](https://docs.aiinsurance.io/api-reference/fmv1-configuration/validate-configuration-spreadsheet.md): Validates the structure and data of an FMV1 configuration spreadsheet without applying any changes. Use this to check for errors before running an import. - [Create Lawsuit](https://docs.aiinsurance.io/api-reference/lawsuits/create-lawsuit.md): Creates a lawsuit for an event. Each event can have at most one lawsuit. Returns 409 Conflict if a lawsuit already exists for the event. - [Delete Lawsuit](https://docs.aiinsurance.io/api-reference/lawsuits/delete-lawsuit.md): Soft-deletes the lawsuit for an event. The lawsuit will no longer be returned by GET requests. - [Get Lawsuit](https://docs.aiinsurance.io/api-reference/lawsuits/get-lawsuit.md): Returns the lawsuit associated with an event. Each event has at most one lawsuit. - [Update Lawsuit](https://docs.aiinsurance.io/api-reference/lawsuits/update-lawsuit.md): Updates the lawsuit for an event. Only provided fields are updated. Send `null` for a field to clear its value. Omit a field to preserve its existing value. - [Create Note](https://docs.aiinsurance.io/api-reference/notes/create-note.md): Creates a new note attached to an event, policy, or insured. - [Delete Note](https://docs.aiinsurance.io/api-reference/notes/delete-note.md): Soft deletes a note by setting deletedAt and deletedBy timestamps. The note will no longer be returned in list or get operations. - [Get Note](https://docs.aiinsurance.io/api-reference/notes/get-note.md): Returns a single note by ID. - [List Notes](https://docs.aiinsurance.io/api-reference/notes/list-notes.md): Returns a paginated list of notes for a specific entity. - [Create Payee](https://docs.aiinsurance.io/api-reference/payees/create-payee.md): Creates a new payee. - [Delete Payee](https://docs.aiinsurance.io/api-reference/payees/delete-payee.md): Soft deletes a payee by setting deletedAt and deletedBy timestamps. The payee will no longer be returned in list or get operations. - [Get Payee](https://docs.aiinsurance.io/api-reference/payees/get-payee.md): Returns a single payee by ID. - [List Payees](https://docs.aiinsurance.io/api-reference/payees/list-payees.md): Returns a paginated list of payees for the company. - [Update Payee](https://docs.aiinsurance.io/api-reference/payees/update-payee.md): Updates an existing payee. Only send fields you want to change. - [Create Policy](https://docs.aiinsurance.io/api-reference/policies/create-policy.md): Creates a new policy directly, primarily for historical imports where policies need to be created without going through the quote→bind wizard flow. - [Delete Policy](https://docs.aiinsurance.io/api-reference/policies/delete-policy.md): Soft deletes a policy by setting deletedAt and deletedBy timestamps. The policy will no longer be returned in list operations. - [Get Policy](https://docs.aiinsurance.io/api-reference/policies/get-policy.md): Retrieves detailed information about a specific policy, including its segments, coverages, exposures, and rating inputs. - [List Policies](https://docs.aiinsurance.io/api-reference/policies/list-policies.md): Returns a paginated list of policies for the company. - [List Policy Transactions](https://docs.aiinsurance.io/api-reference/policies/list-policy-transactions.md): Returns a paginated list of policy transactions (change sets) for a specific policy. Transactions represent the activity log/audit trail of changes made to the policy, including binds, endorsements, cancellations, reinstatements, and renewals. - [Create Quote](https://docs.aiinsurance.io/api-reference/quotes/create-quote.md): Creates a new quote for an existing submission. - [Delete Quote](https://docs.aiinsurance.io/api-reference/quotes/delete-quote.md): Soft deletes a quote by setting deletedAt and deletedBy timestamps. The quote will no longer be returned in list or get operations. - [Get Quote](https://docs.aiinsurance.io/api-reference/quotes/get-quote.md): Returns a single quote with all details. - [Get Quotes Configuration](https://docs.aiinsurance.io/api-reference/quotes/get-quotes-configuration.md): Returns a JSON Schema describing the custom fields available for the `policyInfo.data` object when creating or updating quotes. - [List Quote Info](https://docs.aiinsurance.io/api-reference/quotes/list-quote-info.md): Returns lightweight quote information with essential fields only. Faster response than List Quotes - ideal for dashboards and lists. - [List Quotes](https://docs.aiinsurance.io/api-reference/quotes/list-quotes.md): Returns complete Quote objects with all data fields, including nested quote data, preview data, coverages, and billing information. - [Create Smart Tag](https://docs.aiinsurance.io/api-reference/smart-tags/create-smart-tag.md): Creates a new smart tag for the company. - [List Smart Tags](https://docs.aiinsurance.io/api-reference/smart-tags/list-smart-tags.md): Returns a paginated list of smart tags for the company. - [Attach Files to Submission](https://docs.aiinsurance.io/api-reference/submissions/attach-files-to-submission.md): Attaches one or more PDF files to an existing submission. The files appear in the submission's Files tab and are downloadable from there. - [Create Submission](https://docs.aiinsurance.io/api-reference/submissions/create-submission.md): Creates a new submission. - [Delete Submission](https://docs.aiinsurance.io/api-reference/submissions/delete-submission.md): Soft deletes a submission by setting deletedAt and deletedBy timestamps. The submission will no longer be returned in list or get operations. - [Get Submission](https://docs.aiinsurance.io/api-reference/submissions/get-submission.md): Returns a single submission by ID. - [List Submissions](https://docs.aiinsurance.io/api-reference/submissions/list-submissions.md): Returns a paginated list of submissions for the company. Filter by status, type, or search text. - [Update Submission](https://docs.aiinsurance.io/api-reference/submissions/update-submission.md): Updates an existing submission. Only send fields you want to change (PATCH semantics). - [List Transaction Categories](https://docs.aiinsurance.io/api-reference/transaction-categories/list-transaction-categories.md): Returns a list of transaction categories available for the company. - [Resolve Address](https://docs.aiinsurance.io/api-v1-reference/address-tools/resolve-address.md): Geocode a freeform address string into the FMV1 Address system-object shape — including county. - [Generating API Keys](https://docs.aiinsurance.io/api-v1-reference/authentication.md) - [API Changelog](https://docs.aiinsurance.io/api-v1-reference/changelog.md) - [Overview](https://docs.aiinsurance.io/api-v1-reference/configuration/overview.md) - [Overview](https://docs.aiinsurance.io/api-v1-reference/custom-objects/overview.md) - [Data Models](https://docs.aiinsurance.io/api-v1-reference/data-models.md): Reference for all V1 API data structures, field types, and conventions - [Overview](https://docs.aiinsurance.io/api-v1-reference/documents/overview.md): Generate quote and policy documents from smart tag templates via API - [Overview](https://docs.aiinsurance.io/api-v1-reference/events/overview.md) - [Overview](https://docs.aiinsurance.io/api-v1-reference/exposures/overview.md) - [Overview](https://docs.aiinsurance.io/api-v1-reference/overview.md) - [Overview](https://docs.aiinsurance.io/api-v1-reference/parsing/overview.md): Extract structured data from unstructured insurance documents - [Basic Policies Overview](https://docs.aiinsurance.io/api-v1-reference/policies/basic-overview.md): Simple flat-shape CRUD for policies that don't need transaction history - [Concepts](https://docs.aiinsurance.io/api-v1-reference/policies/concepts.md): How transactions, deltas, segments, and versions work in the Policy API - [Lifecycle Walkthrough](https://docs.aiinsurance.io/api-v1-reference/policies/lifecycle-walkthrough.md): A step-by-step trace through 9 transactions showing how segments evolve - [Overview](https://docs.aiinsurance.io/api-v1-reference/policies/overview.md): Transaction-based policy management with temporal versioning - [Overview](https://docs.aiinsurance.io/api-v1-reference/quotes/overview.md): Manage quotes using the Field Model V1 data structure - [Overview](https://docs.aiinsurance.io/api-v1-reference/rating/overview.md): Invoke the rating engine or supply external rating results via API - [Roadmap](https://docs.aiinsurance.io/api-v1-reference/roadmap.md): Where the v1 API is headed — upcoming capabilities and how the pieces fit together - [Overview](https://docs.aiinsurance.io/api-v1-reference/submissions/overview.md): Group related quotes under a single submission - [System Objects](https://docs.aiinsurance.io/api-v1-reference/system-objects/overview.md): Built-in object types used as field values across FMV1 create/update payloads (Address, CoverageLimit, Currency, Date, QuoteBindError). - [Create an Event ](https://docs.aiinsurance.io/events/create-new-events.md) - [Edit Events](https://docs.aiinsurance.io/events/edit-events.md) - [Event Reserve Updates Smart Tag](https://docs.aiinsurance.io/events/event-reserve-updates.md) - [Export an Event](https://docs.aiinsurance.io/events/exporting-event.md) - [Overview](https://docs.aiinsurance.io/events/understanding-events.md) - [View Events](https://docs.aiinsurance.io/events/view-events/view-events.md) - [Billings](https://docs.aiinsurance.io/financials/billings/billings.md) - [Changing Invoice Name After Sending](https://docs.aiinsurance.io/financials/invoicing/changing-invoice-name.md) - [Custom Billing](https://docs.aiinsurance.io/financials/invoicing/custom-billing.md) - [Delete Files from Invoice](https://docs.aiinsurance.io/financials/invoicing/delete-files-from-invoice.md) - [Down Payment Invoices](https://docs.aiinsurance.io/financials/invoicing/down-payment-invoices.md) - [Financial Transactions](https://docs.aiinsurance.io/financials/invoicing/financial-transactions.md) - [Forwarded Invoices](https://docs.aiinsurance.io/financials/invoicing/forwarded-invoices.md) - [Generating One-Off Invoices](https://docs.aiinsurance.io/financials/invoicing/generating-one-off-invoices.md) - [Invoice Auditing](https://docs.aiinsurance.io/financials/invoicing/invoice-auditing.md) - [Mark Transaction Status Function](https://docs.aiinsurance.io/financials/invoicing/mark-transaction-status.md) - [Overview](https://docs.aiinsurance.io/financials/invoicing/overview.md) - [Record Payment](https://docs.aiinsurance.io/financials/invoicing/record-payment.md) - [Payments](https://docs.aiinsurance.io/financials/payments/payments.md) - [Glossary](https://docs.aiinsurance.io/getting-started/glossary.md) - [Understanding the AI Insurance Model](https://docs.aiinsurance.io/getting-started/intro-to-aiinsurance/understanding-the-ai-insurance-model.md) - [What is AI Insurance](https://docs.aiinsurance.io/getting-started/intro-to-aiinsurance/what-is-aiinsurance.md) - [Getting Started for New Users](https://docs.aiinsurance.io/getting-started/onboarding/getting-started-for-new-users.md) - [How to Add Field Data Model](https://docs.aiinsurance.io/getting-started/setting-up-ai-insurance/adding-data-fields.md) - [What is a Rating Engine](https://docs.aiinsurance.io/getting-started/setting-up-ai-insurance/rating-engine/rating-engine.md) - [Validate a Rating Engine](https://docs.aiinsurance.io/getting-started/setting-up-ai-insurance/rating-engine/validating-rating-engine.md) - [Customer Support Portal](https://docs.aiinsurance.io/getting-started/troubleshooting-and-support/customer-support-portal.md) - [Reach out to Support](https://docs.aiinsurance.io/getting-started/troubleshooting-and-support/reach-out-support.md) - [Welcome](https://docs.aiinsurance.io/homepage.md): Learn how to build on AI Insurance - [Create and Edit an Insured](https://docs.aiinsurance.io/insureds/creating-insureds.md) - [Export Insured Loss Run Report](https://docs.aiinsurance.io/insureds/exporting-insured-loss-run-report/exporting-insured-loss-run-report.md) - [Export Insureds](https://docs.aiinsurance.io/insureds/exporting-insureds.md) - [Filter and Sort Insureds](https://docs.aiinsurance.io/insureds/filter-and-sort-insureds/filter-and-sort-insureds.md) - [Generate artifacts on a single Insured](https://docs.aiinsurance.io/insureds/generating-insured-reports.md) - [OFAC Screening for Insureds](https://docs.aiinsurance.io/insureds/ofac-screening/ofac-screening.md) - [Overview](https://docs.aiinsurance.io/insureds/overview/overview.md) - [View Insured](https://docs.aiinsurance.io/insureds/viewing-insureds.md) - [Setting Up Custom Accounts](https://docs.aiinsurance.io/platform/companies/accounting/setting-up-custom-accounts.md) - [API Keys](https://docs.aiinsurance.io/platform/companies/api-keys.md) - [Brokerages and Broker Management](https://docs.aiinsurance.io/platform/companies/brokerage/brokerage.md) - [Commission Status Overview](https://docs.aiinsurance.io/platform/companies/brokerage/commission-status-pending-premium.md) - [Run Payout Report](https://docs.aiinsurance.io/platform/companies/brokerage/run-payout-report.md) - [Capturing Unallocated Funds](https://docs.aiinsurance.io/platform/companies/cash-management/capturing-unallocated-funds.md) - [Cash Management](https://docs.aiinsurance.io/platform/companies/cash-management/cash-management.md) - [Invoice Links in Cash Management](https://docs.aiinsurance.io/platform/companies/cash-management/invoice-links-in-cash-management.md) - [Operating Account](https://docs.aiinsurance.io/platform/companies/cash-management/operating-account.md) - [Change Company Legal Name](https://docs.aiinsurance.io/platform/companies/company/changing-company-name.md) - [Change Coverage Names](https://docs.aiinsurance.io/platform/companies/company/changing-coverage-names.md) - [Company](https://docs.aiinsurance.io/platform/companies/company/company.md) - [Creating and Validating Forms](https://docs.aiinsurance.io/platform/companies/creating-and-validating-forms/creating-and-validating-forms.md) - [Data Import](https://docs.aiinsurance.io/platform/companies/data-import/data-import.md) - [Files](https://docs.aiinsurance.io/platform/companies/files.md) - [Multi Companies](https://docs.aiinsurance.io/platform/companies/multi-companies/multi-companies.md) - [Payees](https://docs.aiinsurance.io/platform/companies/payees/payees.md) - [Single Sign-On (SSO) Support](https://docs.aiinsurance.io/platform/companies/single-sign-on.md) - [User Roles and Permission](https://docs.aiinsurance.io/platform/companies/user-roles-and-permissions/user-roles-and-permissions.md) - [Activity Feed](https://docs.aiinsurance.io/platform/components/activity-feed/activity-feed.md) - [Assignees](https://docs.aiinsurance.io/platform/components/assignees/assignees.md) - [Contacts](https://docs.aiinsurance.io/platform/components/contacts/contacts.md) - [Files](https://docs.aiinsurance.io/platform/components/files/files.md) - [Notes](https://docs.aiinsurance.io/platform/components/notes/notes.md) - [Overview](https://docs.aiinsurance.io/platform/components/overview.md) - [Smart Tags](https://docs.aiinsurance.io/platform/components/smart-tags/smart-tags.md) - [Underwriting Workbench](https://docs.aiinsurance.io/platform/components/underwriting-workbench/underwriting-workbench.md) - [Calendar and Tasks](https://docs.aiinsurance.io/platform/dashboard/calendar-and-tasks.md) - [Company Overview](https://docs.aiinsurance.io/platform/dashboard/company-overview.md) - [Key Components](https://docs.aiinsurance.io/platform/platform-overview/key-components.md) - [Export Customization and Configuration](https://docs.aiinsurance.io/platform/reporting-and-reports/export-customization-and-configuration.md) - [Export Data](https://docs.aiinsurance.io/platform/reporting-and-reports/exporting-data.md) - [Historical Data Imports: Guidelines and Templates](https://docs.aiinsurance.io/platform/reporting-and-reports/historical-data-imports.md) - [Insured portal](https://docs.aiinsurance.io/policing/insured-portal/insured-portal.md) - [Cancel a Policy](https://docs.aiinsurance.io/policing/policy-management/canceling-a-policy.md) - [Change Policy Billing Email](https://docs.aiinsurance.io/policing/policy-management/changing-policy-billing-email.md) - [Change Policy Numbers on Renewed or Expired Policies](https://docs.aiinsurance.io/policing/policy-management/changing-policy-numbers.md) - [Change Coverage Limits](https://docs.aiinsurance.io/policing/policy-management/coverage/changing-coverage-limits.md) - [Coverage Smart Tags](https://docs.aiinsurance.io/policing/policy-management/coverage/smart-tags.md) - [Delete a Policy](https://docs.aiinsurance.io/policing/policy-management/deleting-a-policy.md) - [Endorse a Policy](https://docs.aiinsurance.io/policing/policy-management/endorsing-policy/overview.md) - [Managing Insured Ratings During Endorsements](https://docs.aiinsurance.io/policing/policy-management/endorsing-policy/removing-insureds-from-rerating.md) - [Export Policy](https://docs.aiinsurance.io/policing/policy-management/exporting-policies/export-policy.md) - [Export Policy Bordereau](https://docs.aiinsurance.io/policing/policy-management/exporting-policies/export-policy-bordereau.md) - [Generate a Certificate of Insurance](https://docs.aiinsurance.io/policing/policy-management/generating-cois.md) - [Create a Policy](https://docs.aiinsurance.io/policing/policy-management/policy-issuance.md) - [Policy Timeline](https://docs.aiinsurance.io/policing/policy-management/policy-timeline.md) - [Renew a Policy](https://docs.aiinsurance.io/policing/policy-management/renewing-a-policy.md) - [Set Policy Numbers](https://docs.aiinsurance.io/policing/policy-management/setting-policy-number.md) - [View Policies](https://docs.aiinsurance.io/policing/policy-management/viewing-a-policy.md) - [Bind a Quote to Policy](https://docs.aiinsurance.io/submissions-and-quotes/binding-the-quote/binding-the-quote.md) - [Create a Submission as a Carrier](https://docs.aiinsurance.io/submissions-and-quotes/creating-a-new-submission/for-carriers.md) - [Create a Submission with the Submission Parsing feature](https://docs.aiinsurance.io/submissions-and-quotes/creating-a-new-submission/submission-parsing.md) - [Export Submissions](https://docs.aiinsurance.io/submissions-and-quotes/exporting-submissions.md) - [Overview](https://docs.aiinsurance.io/submissions-and-quotes/overview.md) - [View all Submissions and Quotes](https://docs.aiinsurance.io/submissions-and-quotes/viewing-submissions/viewing-submissions.md) ## OpenAPI Specs - [generated-external-api](https://docs.aiinsurance.io/openapi/generated-external-api.yaml)