Overview

The Platform APIs provides operations for managing, viewing, and downloading UnderwriteIQ reports and analysis result data.

A report is exportable collection of exposure or analysis. The Risk Data API exposes operations for managing and downloading reports in the Reports and Report Views collections. Reports include:

• A risk data report is an exportable summary of exposure or analysis data. Risk data reports for underwriting workflows include exposure summary reports and analysis summary reports.
• A report view is a collection of reports that return account-level metrics and statistics.

Platform APIs also support operations that enable UnderwriteIQ tenants to create and export exposure and analysis result data that are not available to other entitlements.

Risk Data Reports

A risk data report is an exportable summary of exposure or analysis data.

Risk Data API supports two types of risk data reports in support of underwriting workflows: exposure summary reports and analysis summary reports.

• An exposure summary report (EXPOSURE_SUMMARY) shows a peril-specific overview of an exposure's total insurable value (TIV). This report is available for accounts in PDF or JSON format.
• An analysis summary report (ANALYSIS_SUMMARY) returns analysis settings and exposure information for windstorm exceedance probability (EP) and non-EP DLM analyses. Analysis summary reports are not supported for HD analyses. This report is available in PDF or JSON format.

Exposure Summary Reports

An exposure summary report (EXPOSURE_SUMMARY) returns summary details about an account location exposures including the total insurable value (TIV) of account locations and a breakdown of location TIV by various characteristics.

An exposure summary reports consists of several sections:tiv_summary, geocoding_summary, primary_building_characterstics_summary, hazard_summary, workers_compensation, location_coverage_summary. For detailed information about each section in an exposure summary report, see Exposure Summary Reports in Help Center.

The summary metrics provided in each section represent TIV metrics for aggregations of location exposures that match particular characteristics. For example, in the primary_building_characteristics_summary section, the exposure summary report aggregates all of the buildings that match a particular Number of Stories characteristic (e.g. 8-14 stories) and returns TIV metrics for those location exposures.

TIV metrics include the following:

The Create Risk Data Report supports the creation of exposure summary reports in PDF or JSON for the specified account.

Analysis Summary Report

An analysis summary report (ANALYSIS_SUMMARY) returns analysis settings and exposure information for windstorm exceedance probability (EP) and non-EP DLM analyses.

Analysis summary reports are not supported for HD analyses. This report is available in PDF or JSON format.

The Create Risk Data Report operation enable the client to create an analysis summary report for the specified analysis in PDF or JSON format. To run this report, the client must be assigned the RI-RISKMODELER or RI-UNDERWRITEIQ entitlement.

Marginal Impact Analysis

Marginal impact analysis compares a portfolio-level analysis result with a new analysis that incorporates one or more account-level analysis results. The Intelligent Risk Platform calculates the difference between the reference analysis "group" and the new marginal impact "group".

The Calculate Marginal Impact calculates marginal impact analysis measures the effect of adding additional accounts to an existing portfolio as differential losses.

Download Location Results

The Create Export Job operation supports exporting of location results data to a downloadable CSV file.

The request body specifies the required exportType, resourceType, and settings parameters.

{
  "exportType": "LOCATION_RESULTS",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "CSV",
    "exposureFields": [
      "streetAddress",
      "cityName",
      "county",
      "admin1Name",
      "stateCode",
      "postalCode",
      "zone4Name",
      "zone3Name",
      "zone1",
      "latitude",
      "longitude",
      "countryRMSCode",
      "geoResolutionCode",
      "geoMatchLevel"
    ],
    "perspectiveCodes": ["GU", "GR", "RL"],
    "fileName": "test"
  },
  "resourceUris": ["{{analysis_uri}}"]
}

The request object takes the following parameters in a request to initiate LOCATION_RESULTS job:

The number of analysis result URIs that can be specified in the resourceUris parameter depends on the entitlement assigned to the client. RI-UNDERWRITEIQ client and export up to 100 analysis results per request. RI-EXPOSUREIQ or RI-MODELER clients can export up to 15 analysis results per request.

On success, returns 201 Created HTTP Status Code and returns the URL of the DOWNLOAD_LOCATION_RESULTS job in Location header, e.g. https://host/platform/export/v1/jobs/22912711. Use this URL to poll the status of the job.

When the job is finished, the response returns downloadUrl of the report in the output object.

The exposureFields parameter in the settings object specifies a list of the analysis properties to export. Valid values include: admin1Name, apZone, areaUnit, basinName, biZone, buildingClass, buildingElevation, buildingElevationMatch, buildingHeight, catchmentId, cityName, constructionClassCode, constructionClassScheme, countryRMSCode, county, distanceToCalFireHigh, distanceToCalFireMedium, distanceToCalFireVeryHigh, distanceToClosestMine, distanceToClosestSinkhole, distanceToCoast, distanceToInnerCoast, distanceToWuiInterface, distanceToWuiIntermix, dominantSubperilCS, dominantSubperilWT, dwellTime, elevationAverage, eqBiValue, eqBuildingValue, eqContentsValue, eqSiteDeductible, eqSiteLimit, estimatedEmployees, faultDistance1, faultsBackgroundRates, faultsDistance1, faultsDistance2, faultsDistance3, faultsDistance4, faultsDistance5, faultsName1, faultsName2, faultsName3, faultsName4, faultsName5, faultsReturnPeriodM601, faultsReturnPeriodM602, faultsReturnPeriodM603, faultsReturnPeriodM604, faultsReturnPeriodM605, faultsReturnPeriodM651, faultsReturnPeriodM652, faultsReturnPeriodM653, faultsReturnPeriodM654, faultsReturnPeriodM655, faultsReturnPeriodM701, faultsReturnPeriodM702, faultsReturnPeriodM703, faultsReturnPeriodM704, faultsReturnPeriodM705, fl1000YRInlandDepthUndef, fl1000YrRpDef, fl1000YrRpUndef, fl100YRInlandDepthUndef, fl100YrRpDef, fl100YrRpUndef, fl10YRInlandDepthUndef, fl200YRInlandDepthUndef, fl200YrRpDef, fl200YrRpUndef, fl250YRInlandDepthUndef, fl250YrRpDef, fl250YrRpUndef, fl30YRInlandDepthUndef, fl30YRrpDef, fl30YRrpUndef, fl500YRInlandDepthUndef, fl500YrRpDef, fl500YrRpUndef, fl50YRInlandDepthUndef, fl50YrRpDef, fl50YrRpUndef, flBiValue, flBuildingValue, flContentsValue, floodBfe, floorArea, flSiteDeductible, flSiteLimit, flZone, frBiValue, frBuildingValue, frContentsValue, frSiteDeductible, frSiteLimit, geoMatchLevel, geoResolutionCode, heightUnit, histFireYearCount10km, histFireYearCount20km, histFireYearCount250m, histFireYearCount2km, histFireYearCount5km, HURoofAge, landslide, latitude, liquefaction, locationCurrency, locationId, locationName, locationNumber, longitude, mineArea1, mineArea2, mineArea3, mineArea4, mineArea5, mineDistance1, mineDistance2, mineDistance3, mineDistance4, mineDistance5, mineName1, mineName2, mineName3, mineName4, mineName5, mineStatus1, mineStatus2, mineStatus3, mineStatus4, mineStatus5, mineType1, mineType2, mineType3, mineType4, mineType5, mmi1000, mmi100, mmi1500, mmi200, mmi250, mmi475, mmi500, nfipRate, nfipYear, nfipYearMatch, nship, numberOfBuildings, numberOfStories, occupancyType, occupancyTypeCode, occupancyTypeScheme, otherZones, percentInGeographyCS, percentInGeographyEQ, percentInGeographyFR, percentInGeographyWS, percentInGeographyWT, postalCode, rms100Flzone, rms500Flzone, rmsBuildingElevation, rmsBuildingElevationMatch, score1CS, score1EQ, score1FL, score1FR, score1TR, score1WS, score1WT, score2CS, score2EQ, score2FL, score2WS, score2WT, score3CS, score3EQ, score3FL, score3WS, score3WT, scoreOverall3WS, scoreOverallCS, scoreOverallEQ, scoreOverallFL, scoreOverallFR, scoreOverallTR, scoreOverallWT, sinkHoleArea1, sinkHoleArea2, sinkHoleArea3, sinkHoleArea4, sinkHoleArea5, sinkHoleDistance1, sinkHoleDistance2, sinkHoleDistance3, sinkHoleDistance4, sinkHoleDistance5, sinkholeHazardZone, slopeAverage, soilType, soilTypeDescription, soilVs, SprinklerPresence SprinklerType, stateCode, stochasticBurnProb, streetAddress, tiv, toBiValue, toBuildingValue, toContentsValue, TORoofAge, toSiteDeductible, toSiteLimit, totalEmployees, totalPayroll, trBiValue, trBuildingValue, trContentsValue, trSiteDeductible, trSiteLimit, urbanConFlagRationScore, userid1, userid2, usertxt1, usertxt2, WFRoofAge, wildfireAreaDescription, wildfireFuelTypeDescription, wildFireHazard, wildfireSusceptibility, wildfireThreat, windpoolZone, windpoolZonePremium, ws10000YrRpSurgeDef, ws10000YrRpWind, ws1000YrRpSurgeDef, ws1000YrRpWind, ws100YrRpSurgeDef, ws100YrRpWind, ws10YrRpSurgeDef, ws10YrRpWind, ws1YrRpSurgeDef, ws1YrRpWind, ws200YrRpSurgeDef, ws200YrRpWind, ws250YrRpSurgeDef, ws250YrRpWind, ws25YrRpSurgeDef, ws25YrRpWind, ws2YrRpSurgeDef, ws2YrRpWind, ws500YrRpSurgeDef, ws500YrRpWind, ws50YrRpSurgeDef, ws50YrRpWind, ws5YrRpSurgeDef, ws5YrRpWind, wsBiValue, wsBuildingValue, wsContentsValue, wsSiteDeductible, wsSiteLimit, yearBuilt, yearLastHistFire250m, zone1, zone3Name, zone4Name,

Report Views

A report view is a collection of metrics, statistics, loss tables, and reports that is generated automatically whenever an UnderwriteIQ client creates exposures in batch using the Create Batch Job operation.

A batch job defines single end-to-end workflow that combines multiple operations into a job consisting of discreet tasks that are processed in sequence. For example, a single batch workflow could create , geocode and perform hazard lookups of location exposures, model those exposures, and then export analysis results.

The contents of the report view depend on the tasks defined in the batch job.

Metric Types

These are identified by metric type. The metricType property identifies the type of metric, statistic, loss table, or report returned in the report view.

Report metrics represent risk data reports. The following types of risk data reports can be accessed in report views:

Analysis result metrics represent metrics, statistics, and loss tables calculated or computed in an analysis result. The following types of analysis result metrics can be accessed in report views:

Search Report Views

The Search Report Views operation returns a list of report views.

A report view is a collection of account-level metrics, statistics, loss tables, and reports. These are referred to as metric types within the Risk Data API and include the following: ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1, ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2, ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY, ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE, ACCUMULATIONS_BY_LOCATION, ACCUMULATIONS_BY_POLICY, ACCUMULATIONS_BY_TREATY, ACCUMULATION_EVENTS, ELT, EP, EXPOSURE_SUMMARY, GROUP_ELT, GROUP_EP, GROUP_MARGINAL_EP, GROUP_MARGINAL_STATS, GROUP_PLT, GROUP_POLICY_EP, GROUP_POLICY_STATS, GROUP_STATS, LLR, LOCATION_AAL, LOCATION_RESULTS, MARGINAL_EP, MARGINAL_STATS, PLT, POLICY_EP, POLICY_STATS, and STATS.

For each report view, this operation return high-level information the report view including a list of the types of metrics included:

[
  {
    "reportViewId": 694,
    "reportViewName": "New Business Demo",
    "exposureName": "IMPORT_EDM_RM",
    "createdAt": "2023-04-03T03:19:26.445Z",
    "exposureId": 10171,
    "exposureResourceId": 673,
    "exposureResourceType": "ACCOUNT",
    "exposureResourceTypeId": 8019,
    "createdBy": "[email protected]",
    "notes": "",
    "metricTypes": [
      "STATS",
      "ELT",
      "EP",
      "EXPOSURE_SUMMARY",
      "LOCATION_RESULTS",
      "LOCATION_AAL"
    ]
  }
]

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators. To learn more, see Response Filtering.

Get Report View

The Get Report View operation return detailed information about a specific report view including detailed information about the metrics and reports.

A report view is a collection of metrics, statistics, and loss tables returned one or more analysis results, and one or more reports.

This operation returns summary information about the report view and about the analysis results and reports included in the report.

{
  "reportViewId": 694,
  "reportViewName": "New Business Demo",
  "exposureName": "TEST_IMPORT_EDM_RM",
  "createdAt": "2023-04-03T03:19:26.445Z",
  "exposureId": 10171,
  "exposureResourceId": 673,
  "exposureResourceType": "ACCOUNT",
  "createdBy": "[email protected]",
  "notes": "",
  "details": [ // metric-specific details]
}

The content of the details array varies depending on the metric type.

• If the metricType is returned by an analysis result, the details array provides detailed information about the analysis result that returned the metric, statistic, or loss table.
• If the metricType is returned by report, returns information about the report including the URL of the downloadable report.

Metrics, Statistics, and Loss Tables

For metrics, statistics, and loss tables (e.g. EP, STATS, ELT) returned in an analysis result, the details array returns summary information about that analysis result result including theanalysisId, peril, region as well as the URL of the analysis result itself.

{
  "details": [
    {
      "metricType": "ELT",
      "analysisId": 50556,
      "appAnalysisId": 11891,
      "metricUrl": "https://api-euw1.rms-ppe.com/platform/riskdata/v1/analyses/50556/elt?perspectiveCode=GR&exposureResourceId=673&exposureResourceType=ACCOUNT",
      "additionalInfo": {
        "peril": "EQ",
        "region": "NA",
        "analysisName": "IMPORT_EDM_RM: ACCOUNT: NAEQ-JSON"
      }
    }
  ]
}

The details array returns detailed information about the analysis result that returned the metric, statistic, or loss table.

Reports

For reports (e.g. EXPOSURE_SUMMARY, LOCATION_RESULTS), the response returns summary information about the report and URL of a downloadable report.

{
  "details": [
    {
      "metricType": "EXPOSURE_SUMMARY",
      "metricUrl": "https://xxx.cloudfront.net/xxxexportxxxreportsxxx.json?xxx2025-11-03T19:38:11.076Z",
      "additionalInfo": {
        "reportUuid": "65838911-e557-4cb5-8362-eaf3fbd09ab0"
      }
    }
  ]
}

The details array returns detailed information about the report.

Search Analyses by Report View

The Search Analyses by Report View operation returns detailed information about a list of analysis results included the specific report view.

The path parameter specifies the ID of a report view. If no other parameters are specified detailed information about all analysis results are returned.

For each analysis result returned, the response returns details about the analysis, the analysis currency, the analysis type, and metrics returned:

[
  {
    "analysisId": 50556,
    "appAnalysisId": 11891,
    "analysisName": "IMPORT_EDM_RM: ACCOUNT: NAEQ-JSON",
    "analysisDescription": "USEQ",
    "analysisCurrency": {
      "name": "US Dollar",
      "code": "USD",
      "scheme": "RMS",
      "asOfDate": "2022-06-01T00:00:00Z",
      "vintage": "RL22"
    },
    "analysisType": "DLM",
    "analysisFramework": "ELT",
    "peril": "EQ",
    "region": "NA",
    "metricTypes": ["ELT", "EP", "STATS"]
  }
]

Responses can be filtered by analysisId or appAnalysisId using query string parameters. Depending on the property, you may use a combination of comparison operators and list operators.To learn more, see Response Filtering.

Accumulations

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

An exposed limit represents the maximum possible loss to an insurer or reinsurer for a policy or treaty from a single deterministic event occurrence. The 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.

A report view returns the following geopolitical accumulation metrics:

• ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1
• ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2
• ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY
• ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE
• ACCUMULATIONS_BY_LOCATION
• ACCUMULATIONS_BY_POLICY
• ACCUMULATIONS_BY_TREATY
• ACCUMULATION_EVENTS

📷

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.

📷

Limited Support

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