API Reference

Create model job

post
https://{host}/platform/model/v1/jobs

Models the specified exposure using an ALM, DLM, or HD model.

A model (catastrophe model) is a computational tool that can be used to assess and estimate the likelihood and severity of future natural and man-made events and to quantify the financial impact of those disasters on an organization’s assets.

The request must specify the resourceUri, resourceType, type, and type-specific configurations that that are specified in the settings object.

Exposures and Exposure Variations

This operation supports modeling of both exposures (accouts, aggregate portfolio, portfolios) and exposure variations (account variations, aggregate portfolio variations, and portfolio variations).

  • An exposure (account, aggregate portfolio, or portfolio) is collection of insured properties (locations) that are vulnerable to catastrophe risk and may produce a financial loss, i.e. locations. Model jobs run on an exposure will automatically create a new exposure variation and calculate losses based on that exposure variation. To learn more, see Exposures Variations.
  • An exposure variation is an immutable, snapshot of an exposure at a particular point in time. Variations enable tenants to better manage exposure data by ensuring that analyses, reports, and data exports accurately reflect the state of an exposure. Model jobs run on an exposure variation calculate losses based on exposure data at a particular point-in-time. To learn more, see Exposures.

Whenever the Intelligent Risk Platform performs an analysis of an exposure and generates an analysis, it automatically creates an immutable point-in-time snapshot of that exposure and its data, called an exposure variation.

ALM Models

ALM models can be used to model aggregate portfolios and aggregate portfolio variations.

For a list of supported ALM models, see ALM Models.

DLM Models

DLM models can be used to model accounts, portfolios, account variations, and portfolio variations.

For a list of supported DLM models, see DLM Models.

HD Models

HD models can be used to model accounts, portfolios, account variations, and portfolio variations.

For a list of supported ALM models, see HD Models.

Polling Model Jobs

If successful, returns 201 Created HTTP response and the URL of an ALM, DLM or HD job in the d Location header.

For details, see Get Model Job.

🪰

Entitlements

RI-EXPOSUREIQ RI-RISKMODLER RI-UNDERWRITEIQ

Language
Credentials
URL