API Reference

Variation API Overview

Overview

The Variation API defines resources that enable the client to manage the creation of exposure variations (version 1).

An exposure variation (v1) is an immutable snapshot of an account or portfolio resource that can be used to compute accumulation analysis.

An accumulation is a type of analysis that enables Intelligent Risk Platform tenants identify areas of concentrated property or workers compensation exposure so that you can assess worst-case scenarios. Accumulations calculate the exposed limit, the maximum loss from a single deterministic event. To learn more, see Accumulation API.

Accumulation analysis based on an exposure variation (v1) enable tenants to ensure accumulation analysis use the same same data, regardless of the time between analyses.

📷

Note

Intelligent Risk Platform supports two exposure variation versions:

  • Exposure variation (v1) support accumulation analysis.
  • Exposure variation (v2) support accumulation, ALM, DLM, and HD analysis.

Operations

The Variation API exposes the following operations:

OperationMethodPathDescription
Create Variation JobPOST/platform/variation/v1/jobsCreates an ACCOUNT_VARIATiON or PORTFOLIO_VARIATION job.
Search Variation JobPOST/platform/variation/v1/jobsReturns list of exposure varations.
Get Variation JobGET/platform/variation/v1/jobs/{jobId}Get exposure variation.
Update Variation JobPATCH/platform/variation/v1/jobs/{jobId}Update status of exposure variation job.

Entitlements

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

  • RI-EXPOSUREIQ
  • RI-RISKMODELER