API Reference

Introduction

The Modern Insurer API lets you programmatically manage insurance workflows in your applications. Use our API to create and manage adjusters, file claims, schedule property inspections, and more.

API Design

The Modern Insurer API follows REST conventions. We use HTTP, resource-oriented URLs, and standard HTTP verbs (e.g., POST, GET, PUT). All responses, including errors, are returned in JSON format.

Our API uses predictable resource-oriented URLs:

  • Collections use plural nouns (e.g., /adjusters, /claims, /inspections)
  • Individual resources are accessed by their ID (e.g., /adjusters/{id}, /claims/{id})
  • Related actions use subresources (e.g., /inspections/{id}/cancel, /invoices/{id}/approve)

Request data is sent as JSON in the request body. For example, to create a new adjuster:

POST /adjusters
{
 "firstName": "John",
 "lastName": "Smith", 
 "email": "[email protected]",
 "phoneNumber": "14155551234"
}

Successful responses include the created or modified resource. For example:

{
  "adjusterId": "507f1f77bcf86cd799439011",
  "firstName": "John",
  "lastName": "Smith",
  "email": "[email protected]",
  "phoneNumber": "14155551234"
}

Authentication

The Modern Insurer API uses API keys to authenticate requests. All API requests must include your API key in an x-api-key header.

Keep your API keys secure and do not share them in publicly accessible areas. If you believe your API key has been compromised, contact us immediately.

Backwards Compatibility

We take API stability seriously and follow these principles to avoid breaking your integrations:

  • Existing fields will not be removed or renamed
  • New fields and endpoints may be added, but will be optional
  • The format or type of existing fields will not change
  • Error codes and their meaning will remain consistent
  • New error codes may be added for new functionality

When we need to make breaking changes, we:

  1. Release a new API version
  2. Support the previous version for at least 12 months
  3. Notify you by email at least 6 months before deprecating an old version