Skip to main content
The Submissions and Quotes docs cover the /api/external/... routes for creating and managing submissions and quotes. Our codebase also talks to another surface used for day to day operations under /api/companies/.... We call this the Operations API. It is used by client applications to import data, look up insureds and policies, read configuration, and trigger background jobs.

​
Why this section exists

  • These endpoints are actively used in our applications.
  • They were not clearly documented next to Submissions and Quotes.
  • This section groups them in one place so engineers can find paths quickly.

​
When to use the Operations API

Use it when you need to:
  • Submit files or records as a processing job
  • Look up or create insureds
  • List policies for matching or enrichment
  • Read operational configuration such as email submission settings
If you are building submission or quoting flows for external users, start with Submissions and Quotes.

​
How it relates to Submissions and Quotes

There are two API surfaces:
  • External surface: /api/external/companies/... for submissions and quotes
  • Operations surface: /api/companies/... for internal and back office tasks used by our applications
Some configuration routes live on the external surface but are relevant here, so they are referenced for completeness.

​
Endpoint map

Paths only for quick reference. Details are on the child pages.

​
Jobs

  • POST /api/companies/{company_id}/jobs

​
Events

  • POST /api/companies/{company_id}/events/list

​
Insureds

  • POST /api/companies/{company_id}/insureds
  • POST /api/companies/{company_id}/insureds/options

​
Policies

  • POST /api/companies/{company_id}/policies/list

​
Configuration

  • GET /api/companies/{company_id}/submissions/email
  • GET /api/external/companies/{company_id}/configuration (included here for parity with usage)

​
Notes on stability and naming

  • All operations routes use the /api/companies/... prefix.
  • company_id is a required path parameter across endpoints.
  • Authentication, request and response schemas, and error handling are documented on the specific pages.