Skip to main content
Events represent operational records such as claims or incidents. Use these routes to find events already in the system and to update their financials when needed.
Scope: paths and request format. Response examples and full schemas can be added later.

​
Endpoints

  • POST /api/companies/{company_id}/events/list
  • GET /api/companies/{company_id}/events/<claim|incident>
  • POST /api/companies/{company_id}/events/financials

​
Authentication and headers

Send an API key and JSON payload. 
Authorization: ApiKey <YOUR_API_KEY>
Content-Type: application/json
Accept: application/json

​
List events

Use this to search for events and page through results.

​
Request body shape

{
  "filters": {
    "historicalEventId": "<optional-external-id>",
    "claimNumber": "<optional-claim-number>",
    "incidentDateFrom": "<optional-ISO-date>",
    "incidentDateTo": "<optional-ISO-date>",
    "insuredId": "<optional-internal-insured-id>"
  },
  "pagination": {
    "page": 1,
    "limit": 50
  },
  "sort": {
    "field": "updatedAt",
    "direction": "desc"
  }
}
Fields are optional and can be combined. If no filters are given the endpoint returns the first page of recent events.

​
Example: list by historical id

curl -X POST   "$BASE_URL/api/companies/$COMPANY_ID/events/list"   -H "Authorization: ApiKey $API_KEY"   -H "Content-Type: application/json"   -d '{
    "filters": {
      "historicalEventId": "EVT-2024-000123"
    },
    "pagination": { "page": 1, "limit": 25 },
    "sort": { "field": "updatedAt", "direction": "desc" }
  }'

​
Example: list by date range and insured

curl -X POST   "$BASE_URL/api/companies/$COMPANY_ID/events/list"   -H "Authorization: ApiKey $API_KEY"   -H "Content-Type: application/json"   -d '{
    "filters": {
      "incidentDateFrom": "2024-01-01",
      "incidentDateTo": "2024-12-31",
      "insuredId": "ins_9c8f2a"
    },
    "pagination": { "page": 1, "limit": 50 }
  }'

​
Fetch a single event

You can request a specific type by replacing the placeholder in the path.
  • GET /api/companies/{company_id}/events/claim?id=<internal-or-historical-id>
  • GET /api/companies/{company_id}/events/incident?id=<internal-or-historical-id>
curl -X GET   "$BASE_URL/api/companies/$COMPANY_ID/events/claim?id=EVT-2024-000123"   -H "Authorization: ApiKey $API_KEY"

​
Update event financials

Use this to set or adjust reserves and other financial figures for existing events.

​
Request body shape

{
  "updates": [
    {
      "eventId": "<internal-id-or-historical-id>",
      "currency": "USD",
      "reserves": {
        "total": 12500.0,
        "indemnity": 10000.0,
        "expense": 2500.0
      },
      "notes": "Quarterly reserve review"
    }
  ]
}
Submit one or more updates in a single call.

​
Example: update reserves for two events

curl -X POST   "$BASE_URL/api/companies/$COMPANY_ID/events/financials"   -H "Authorization: ApiKey $API_KEY"   -H "Content-Type: application/json"   -d '{
    "updates": [
      {
        "eventId": "EVT-2024-000123",
        "currency": "EUR",
        "reserves": { "total": 9000.0, "indemnity": 7000.0, "expense": 2000.0 },
        "notes": "Adjusted after repair estimate"
      },
      {
        "eventId": "EVT-2024-000124",
        "currency": "EUR",
        "reserves": { "total": 15000.0, "indemnity": 12000.0, "expense": 3000.0 }
      }
    ]
  }'

​
Parameters

  • company_id is a required path parameter.
  • page and limit control pagination in listing calls.
  • For single-event fetches, provide id as a query parameter.

​
Notes

  • Listings are read-only and safe to call repeatedly.
  • Financial updates are write operations. Use idempotent request identifiers on the client side if your integration retries.