API Reference

Create model profile

post
https://{host}/analysis-settings/modelprofiles

Creates a model profile.

A model profile is a collection of configurations that are used to analyze exposures. Model profiles may specify perils, regions, and model versions, as well as model-specific settings, such as sub-perils and post loss amplification.

This operation supports the creation of both DLM model profiles and HD model profiles.

  • DLM model profiles store analysis settings and model-specific settings. DLM model profiles are required for running a DLM analysis. DLM model profiles are supported for earthquake, flood, severe convective storm, windstorm, and winterstorm perils.
  • HD model profiles store analysis settings, model-specific settings, and simulation settings. HD model profiles are required for running a High Definition Model™ analysis. HD model profiles are supported for earthquake, flood, severe convective storm, terrorism, wildfire, and windstorm perils.

Every model profile is defined by a DLM or HD model that supports loss analysis for specific regions and perils. For a complete list of supported models, see Models Available in Risk Modeler

📷

Note

Although you can create model profiles based on models that you do not license, you cannot use those model profiles to analyze exposures. Platform returns an error message if you attempt to use an unlicense model.

Check with your Intelligent Risk Platform administrator to find out which models are licensed by your organization.

📷

Note

All subregions must licensed. If you create a model profile for a region with multiple subregions, and you do not license all of those subregions, Platform returns will return an error. To successfully run an analysis on a model's subregions, create a model profile for only the subregions you license. Check with your Intelligent Risk Platform administrator to find out which models are licensed by your organization.

Body Params
string
enum
required

Natural or man-made phenomenon that generates insurance loss.

  • DLM model profiles accept Earthquake, Flood, Severe Convective Storm, Windstorm, and Winterstorm perils.
  • HD model profiles accept Earthquake, Flood, Severe Convective Storm, Terrorism, Wildfire, and Windstorm perils.
Allowed:
string
enum

Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss.

Perils include earthquake (EQ), flood (FL), severe convective storm (CS), terrorism (TR), wildfire (WF), windstorm/hurricane/cyclone/typhoon (WS), and winterstorm (WT).

Allowed:
string
required

Region covered by the model profile, e.g. Austrailia, Caribbean, Central America, China

See RMS Model Regions and Region Codes.

string
required

Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril e.g. ACEQ, EUFL. For information about models and model updates, see Models and Data in the Moody's Support Center.

string
required

Source of the engine to be used in the analysis, e.g. RMS

string
enum
required

Version of model engine used in model profile.

string
required

Name of model profile. Moody's recommends that establish a naming convention that will help you identify the profile you want to use for an analysis.

string
enum
required

Type of analysis. Examples include Exceedance Probability and Scenario.

string
string

Subregion within the specified region, e.g. Belgium is a subregion within EU

See RMS Model Regions and Region Codes

integer | null
Responses

400

Bad request (wrong or missing inputs)

500

ERROR: Internal Server Error

Updated about 1 month ago

Language
Credentials
URL
Response 
 Choose an example:
*/*
Updated about 1 month ago