Skip to main content
Use these routes to read configuration that controls ingestion and processing behavior.
Scope: paths and request format. Response examples and full schemas can be added later.

​
Endpoints

  • GET /api/companies/{company_id}/submissions/email
  • GET /api/external/companies/{company_id}/configuration
Note: /api/external/companies/{company_id}/configuration is the same endpoint documented under Submissions & Quotes → Get Configuration. We reference it here only to explain how it is used in operations/imports.

​
Authentication and headers

Provide an API key. Responses are JSON. 
Authorization: ApiKey <YOUR_API_KEY>
Accept: application/json

​
Email submission settings

Read the configuration that governs how inbound emails are handled for a company.

​
Request

GET /api/companies/{company_id}/submissions/email

​
Example

curl -X GET   "$BASE_URL/api/companies/$COMPANY_ID/submissions/email"   -H "Authorization: ApiKey $API_KEY"

​
Typical response fields

{
  "enabled": true,
  "ingestionMailbox": "claims+acme@example.com",
  "maxAttachments": 20,
  "allowedMimeTypes": ["application/pdf", "image/jpeg", "image/png", "message/rfc822"],
  "transactionConfiguration": {
    "categories": ["invoice", "credit_note", "payment_advice"],
    "currencyDefault": "EUR"
  },
  "rules": [
    {
      "name": "Skip auto reply",
      "condition": { "subjectContains": "[AUTO-REPLY]" },
      "action": { "ignore": true }
    }
  ],
  "updatedAt": "2025-01-12T10:45:00Z"
}
Field names may vary by tenant configuration. Treat unknown fields as forward compatible.

​
Company configuration

Read general company configuration. This response is the source of truth for coverage types, entity types, and the field catalog (rating and non‑rating).

​
Request

GET /api/external/companies/{company_id}/configuration

​
Example

curl -X GET   "$BASE_URL/api/external/companies/$COMPANY_ID/configuration"   -H "Authorization: ApiKey $API_KEY"

​
Typical response fields (selected)

{
  "enabledCoverageTypes": ["property", "liability", "auto_fleet"],
  "insuredEntityTypes": ["organization", "individual"],
  "ratingEngineFields": { /* fields used for quoting */ },
  "nonRatingFields": {
    "events": { /* fields used for event records */ },
    "policies": [ /* fields used for policy records */ ],
    "insureds": [ /* fields used for insured records */ ]
  },
  "updatedAt": "2025-01-12T10:45:00Z"
}

​
Parameters

  • company_id is a required path parameter.

​
Notes

  • Both endpoints are read only.
  • Cache responses on the client side to reduce load. Invalidate when users change settings in the UI or after a successful save operation.

​
Why you might use these together

Example only When mapping existing columns from a loss run sheet into the platform’s standard fields for a specific company, we first need to know what fields and financial categories exist in that company.
  • Use /api/external/companies/{company_id}/configuration to learn the available fields for events and policies. This is the list of canonical fields you can map into.
  • Use /api/companies/{company_id}/submissions/email to learn the available financial categories and related rules. These are the buckets for invoices, credits, payments, and similar items.
We can use these two responses as the context for an LLM so it can decide: this column name from the sheet should map to this field, and this amount should belong to that financial category. This is just one example of how these endpoints are used together.