November, 2023
The November 7 release of the Platform APIs.
ESG Data API
Identifying, understanding and managing risks are at the core of the insurance industry. All risks have various dimensions, but the environmental, social, and governance (ESG) profile of risk is a dimension that has only recently found its way into risk analysis in the industrial insurance segment.
ESG data enables the platform to calculate ESG scores at the account level and an overall portfolio score to show their combined impact on your portfolio.
The ESG Data API enables you to match accounts defined in a portfolio variation with companies defined in the Orbis database, a database of ESG data, and calculate ESG scores (e.g. esgScores
, detailedEsgScores
, historicalScores
) for each matched account.
The Match ESG Companies operation (POST
/platform/esgdata/v1/companies/match
) matches the specified company names against the accounts in a portfolio variation. The required portfoliovariation
body parameter identifies the portfolio variation.
The required x-rms-resource-group-id
header that identifies a resource group.
The Get ESG data jobs operation (GET
/platform/esgdata/v1/jobs
) enables you to view a filtered list of matching jobs.
The Get ESG data job operation (GET
/platform/esgdata/v1/jobs/{jobId}
) now returns information about matching jobs.
The Update ESG job operation (PATCH
/platform/esgdata/v1/jobs/{jobId}
) updates the specified ESG Data job. In the current release, this operation enables you to cancel or set the priority of the job.
The Get ESG Companies operation (GET
/platform/esgdata/v1/companies
) enables you retrieve a filtered list of ESG companies. For each company, the response returns ESG data and ESG scores.
The Get ESG Company operation (GET
/platform/esgdata/v1/company/{companyId}
) enables you to retrieve ESG Company by Orbis ID with ESG information.
Export API
The Create Export operation (POST
/platform/export/v1/jobs
) now supports exports of analyses asRDM
file in the BAK
and MDF
data formats with RDM
export type.
The Create Export operation (POST
/platform/export/v1/jobs
) now supports exports of analyses asRDM
database to the Data Bridge server with RDM_DATABRIDGE
export type.
The Create Export operation (POST
/platform/export/v1/jobs
) now supports exports of analysis results in the CSV
and PARQUET
data formats with RESULTS
export type.
The Create Export operation (POST
/platform/export/v1/jobs
) now supports exports of analysis results combined with location exposure fields in the CSV
data format with LOCATION_RESULTS
export type.
The Get Export Jobs, Get Export Job, and Update Export Job operations has added support for RDM
, RDM_DATABRIDGE
, RESULTS
, and LOCATION_RESULTS
export types
Import API
The Create Import operation (POST
/platform/import/v1/jobs
) now supports the imports of RDM
file in the BAK
and MDF
data formats with RDM
import type.
The Create Import operation (POST
/platform/import/v1/jobs
) now supports the imports of RDM
database from Data Bridge server with RDM_DATABRIDGE
import type.
The Get Import Jobs, Get Import Job, and Update Import Job operations has added support for RDM
andRDM_DATABRIDGE
import types
Risk Data API
The Get Exposure Variations operation (GET
/platform/riskdata/v1/exposurevariations
) returns a list of exposure variations with current support of only portfolio variations.
The Get Exposure Variation operation (GET
/platform/riskdata/v1/exposurevariations/{exposureVariationId}
) returns the specified exposure variation with current support of only portfolio variation.
STEP API
The STEP API defines operations for managing STEP jobs to run Stochastic Conditional Exceedance Probability (Stocjastic CEP / STEP) analysis.
Stochastic CEP (STEP) enables you to estimate the potential probabilistic losses before and after catastrophe events. STEP facilitates the extraction of loss data from EDMs and exporting that data as a single combined exceedance probability (EP) curve or as multiple individual EP curves and the associated treaty losses.
The Create Step Job operation (POST
/platform/step/v1/jobs
) creates and runs a new STEP job
The Get Step Jobs operation (GET
/platform/step/v1/jobs
) retrieves and filters a list of STEP jobs.
The Get Step Job operation (GET
/platform/step/v1/jobs/{jobId}
) retrieves the specified STEP job.
The Update Step Job operation (PATCH
/platform/step/v1/jobs/{jobId}
) updates the specified STEP job. In the current release, this operation enables you to cancel or set the priority of the job.
Variation API
The Variation API defines operations for managing Variation jobs that enable you to create immutable versions (or variations) of Risk data exposures.
A variation is an immutable snapshot version of an exposure (e.g. portfolio, account, location). In this initial release, the Variation API enables support for portfolio Variations only.
The Create Variation operation (POST
/platform/variation/v1/jobs
) creates a new Variation job.
The Get Variations operation (GET
/platform/variation/v1/jobs
) retrieves and filters a list of Variation jobs.
The Get Variation operation (GET
/platform/variation/v1/jobs/{jobId}
) returns the specified Variation job.
The Update Variation operation (PATCH
/platform/variation/v1/jobs/{jobId}
) updates or cancels the specified Variation job