API Reference

Accumulation API Overview

Overview

An accumulation is a type of catastrophe analysis that identifies areas of concentrated property or workers compensation exposure. The analysis calculates the exposed limit for accounts by policy, treaty, or geographic granularity. The accumulation analysis enables underwriters to quickly identify and assess worst-case scenarios.

The exposed limit represents the maximum possible loss to an insurer or reinsurer for a policy or treaty from a single deterministic event occurrence. This exposed limit takes into account all policy and location coverage terms, including policy restrictions, sublimits, and deductibles.

Following an accumulation analysis, exposed limit is allocated back to each individual location based on its TIV share of the policy TIV (for primary insurance) or based on its share in the treaty TIV (for reinsurance). This allocated exposed limit is an additive metric and enables aggregation and filtering of exposure attributes to understand what is driving the overall exposed limit.

Operations

The Accumulation API consists of two collections: Accumulation Jobs and Accumulation Profiles.

Accumulation Jobs

The Accumulation Jobs collection contains operations for creating and managing workflow jobs that do accumulation analysis.

📷

Limited Support

The Accumulation API does not currently support retrieving the results of accumulation analysis. The Export API supports the RESULTS export type, which can be used to download the results of an accumulation analysis.

Accumulation analysis based on four resource types: businessHierarchy, account, profile, or profileVariation.

OperationMethodPath
Create Accumulation JobPOST/platform/accumulation/v1/jobs
Search Accumulation JobsGET/platform/accumulation/v1/jobs
Get Accumulation JobGET/platform/accumulation/v1/jobs/{jobId}
Update Accumulation JobPATCH/platform/accumulation/v1/jobs/{jobId}

Running an accumulation job on a portfolio automatically creates a exposure variation based on that portfolio. For information on exposure variations, see Variation API.

Accumulation Metrics

The Accumulation API does not currently support retrieving the results of accumulation analysis.

The Export API and Risk Data API support operations for viewing accumulation analysis results:

  • The Export API supports the RESULTS export type, which can be used to download the results of an accumulation analysis.
  • The Get Report View operation returns detailed information about a report view and any accumulation metrics included in that report view.

Accumulation metrics include:

Metric TypeDescription
ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1Exposed limit by large geographic division, e.g. state, province, or region.
ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2Exposed limit by small geographic division, e.g. county.
ACCUMULATIONS_BY_GEOGRAPHY_COUNTRYExposed limit by country.
ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODEExposed limit by post code, e.g. ZIP code.
ACCUMULATIONS_BY_LOCATIONExposed limit by location.
ACCUMULATIONS_BY_POLICYExposed limit by policy.
ACCUMULATIONS_BY_TREATYExposed limit by treaty.
ACCUMULATION_EVENTSExposed limit by event.

Accumulation Profiles

An accumulation profile is a set of configurations that defines the output to be generated by an analyses.

An accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.

📷

Limited Support

The Accumulation API does not currently support creating or updating accumulation profiles. To perform these operations, use the ExposureIQ application.

One or more accumulation profiles must be specified in every accumulation job.

OperationMethodPath
Search Accumulation ProfilesGET/platform/accumulation/v1/profiles
Get Accumulation ProfileGET/platform/accumulation/v1/profiles/{profileId}

Entitlements

Client must be assigned one of the following entitlements to use this API:

  • RI-EXPOSUREIQ
  • RI-RISKMODELER
  • RI-UNDERWRITEIQ