Overview
Exposure enrichment is a process that enhances location exposures with building attribute data enabling insurers and reinsurers to improve the quality of exposure data.
The Enrich Exposure API supports workflows that enrich location exposures with building attribute data from CAPE Property Intelligence and other licensed data products. Depending on the job settings, this operation may supplement or overwrite existing building attributes including primary characteristics and secondary modifiers.
Operations
| Operation | Method | Endpoint | Description |
|---|---|---|---|
| Create Enrich Exposure Job | POST | /platform/enrichexposure/v1/jobs | Creates ENRICH_EXPOSURE job. |
| Update Enrich Exposure Job | PATCH | /platform/enrichexposure/v1/jobs/{jobid} | Updates ENRICH_EXPOSURE job. |
| Search Enrich Exposure Jobs | GET | /platform/enrichexposure/v1/jobs | Returns list of ENRICH_EXPOSURE jobs. |
| Get Enrich Exposure Job | GET | /platform/enrichexposure/v1/jobs/{jobid} | Polls ENRICH_EXPOSURE job. |
Entitlements
Client must be assigned one of the following entitlements to use this API:
RI-EXPOSUREIQRI-RISKMODELERRI-UNDERWRITEIQ
Licensing
The scope of exposure enrichment (the breath of enriched data available) depends on the data product licensed by the tenant.
Standard Enrichment License
Tenants that have an ExposureSource Database - United States - Platform license have access standard, "ESDB residential" data.
The enhanced data enables insurers and reinsurers assess and improve the quality of exposure data, or to pre-fill exposure data if none is available. The database consists of commercial and residential building attribute data that is compiled from a number of third-party databases and/or validated through extensive field surveys, satellite imagery, photographs, research, and other sources.
Supported Properties
Locations can be enriched with the following building attributes with an ExposureSource Database - United States - Platform (TP-ESDB-USA) license:
buildingHeight, construction, currencyCode, eqEngineeringFoundationId, eqPoundingId, eqShapeConfigureId, flFoundationTypeId, floorArea, floorOccupancy, frRoofAgeId, frRoofCoveringId, isPrimaryBuildingFlag, locId, numOfStories, occupancy, roofYear, toCladTypeId, toGaragingId, toRoofAgeId, toRoofEquipmentId, toRoofGeometryId, toTreeDensityId, wfArchitectureId, wfCladSysId , wfDeckSysId, wfSlopeFlagId, wfSlopeId, wfd2vFlagId, wfd2vUnitId, wfd2v, wsArchitectureId, wsCladTypeId, wsFoundationId, wsRoofAgeId, wsRoofEquipmentId, wsRoofGeometryId, wsRoofMaintenanceId, wsRoofSystemId, yearBuilt
ERD Enrichment License
Tenants that have an Enhanced Risk Data (ERD) license have access to both "ESDB Residential" data and enhanced property data that is available through CAPE Property Intelligence.
Enhanced property data includes extended building and hazard attributes, roof date components, architecture and roof system identifiers, cladding, garaging, tree density, deck and slope attributes, foundation and engineering identifiers, and related flags. Enhanced building attributes data is only returned if property values are available for the location.
Supported Properties
The following properties are returned with a ERD (ERD-EE-US) license:
airConditioningDescription, buildingHeight , buildingValuationLowerRange, buildingValuationUpperRange , constructionSource , construction, currencyCode, eqEngineeringFoundationId, eqPoundingId , eqShapeConfigureId, esdbVersion , flFoundationTypeId , floorAreaSource , floorArea, floorOccupancyDescription , floorOccupancy, foundationSystemDescription, frRoofAgeId, frRoofCoveringId, heatingTypeDescription , isHD, isPrimaryBuildingFlag , locId , multipleBuildingFlagDescription , multipleBuildingFlag, numOfStoriesSource , numOfStories, numberOfBaths , numberOfBedrooms, numberOfUnits , occupancy2 , occupancy3, occupancySource , occupancy, pool, roofYear , toCladTypeId, toGaragingId, toRoofAgeId , toRoofEquipmentId , toRoofGeometryId, toTreeDensityId , wfArchitectureId , wfCladSysId , wfDeckSysId , wfSlopeFlagId, wfSlopeId, wfd2vFlagId, wfd2vUnitId , wfd2v, wsArchitectureId, wsCladTypeId , wsFoundationId, wsRoofAgeId, wsRoofEquipmentId, wsRoofGeometryId , wsRoofMaintenanceId , wsRoofSystemId , yearBuiltSource, yearBuilt
The enhanced data that is added to the location exposure depends on the license.
Update Building Attribute Data
The settings object accepts the optional transferData parameter, which accepts a Boolean value. If the transferData parameter is true, the enriched data is overwrites the existing primary characteristic and secondary modifier data for the enriched locations.
The Create Enrich Exposure operation supports updating location primary characteristics (construction, yearBuilt, numOfStories, occupancy) and a subset of secondary modifiers.
| Property | Table | Field | Description |
|---|---|---|---|
buildingHeight | Property | BLDGHEIGHT | Building Height |
construction | Property | BLDGSCHEME, BLDGCLASS | Construction Scheme and Code |
| Convective Storm Architecture | todet | ARCHITECT | Residential Appurtenant Structures |
toCladTypeId | todet | CLADSYS | Cladding Type |
toGaragingId | todet | GARAGING | Garaging |
toRoofAgeId | todet | ROOFAGE | Roof Age/Condition |
toRoofEquipmentId | todet | ROOFEQUIP | Rooftop Equipment |
toRoofGeometryId | todet | ROOFGEOM | Roof Geometry |
| Convective Storm Roof System | todet | ROOFSYS | Roof System Covering |
toTreeDensityId | todet | TREEDENSITY | Tree Density |
floorArea | Property | FLOORAREA | Floor Area |
floorOccupancy | Property | FLOOROCCUPANCY | Floor Occupancy |
isPrimaryBuildingFlag | Property | PRIMARYBLDG | Primary Building |
numOfStories | Property | NUMSTORIES | # of Stories |
occupancy | Property | OCCSCHEME, OCCCLASS | Occupancy Scheme and Code |
| Roof Maintenance | todet | ROOFMAINT | Roof Maintenance |
roofYear | Property | ROOFYEAR | Roof Year |
wsArchitectureId | hudet | ARCHITECT | Residential Appurtenant Structures |
wsCladTypeId | hudet | CLADSYS | Cladding Type |
wsFoundationId | hudet | HUFOUNDATIONTYPE | Foundation Type |
wsRoofAgeId | hudet | ROOFAGE | Roof Age/Condition |
wsRoofEquipmentId | hudet | ROOFEQUIP | Roof Equipment Hurricane Bracing |
wsRoofGeometryId | hudet | ROOFGEOM | Roof Geometry |
wsRoofSystemId | hudet | ROOFSYS | Roof Covering |
yearBuilt | Property | YEARBUILT | Year Built |
