API Reference

Accumulation API Overview

Overview

An accumulation is a type of analysis that enables you to identify areas of concentrated property or workers compensation exposure so that you can assess worst-case scenarios.

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 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