Policy Snapshots and Coverage Summaries

Overview

Several common integration scenarios require certain views of the policy data in relation to a reference time. We support two views:

A “snapshot” of what the policy looked like as of a certain time. This will show what the policy would look like if you went back in time and examined a policy on that date. Shapshots have, for each policy entity, an array of characteristics objects to show coverage across time.

A “summary” of what the coverage is as of a certain time. This shows, assuming the policy is current, what the coverage was for a given date. It can also be extended to answer the broader question of “On date X, what did the policy show for coverage on date Y.” Summaries have, for each policy entity, at most one characteristics object, which shows the specific coverage for the given date.

API

Snapshots

The following endpoint can be used to retreive a policy snapshot:

Get a policy snapshot as of certain time
POST /policies/{policyLocator}/snapshot
PolicySnapshotRequest
required
snapshotTimestamp timestamp

The snapshotTimestamp indicates the time at which you want the snapshot to be based. Policy transactions that were issued after this time will not be reflected in the response.

PolicySnapshotResponse
required
locator string
policyholderLocator string
productName string
snapshotTimestamp timestamp
ExposureSnapshotResponse
required
locator string
name string
PerilSnapshotResponse
required
locator string
name string
characteristics [PerilCharacteristicsResponse]
renewalGroup string

Coverage Summary

The followign endpoint can be used to retreive a policy coverage summary:

Get a policy coverage at certain point in time
POST /policies/{policyLocator}/coverageSummary
CoverageSummaryRequest
required
coverageReferenceTimestamp timestamp

optional
policyHistoryTimestamp timestamp

The coverageReferenceTimestamp is the time to consider for coverage. For example, you could set this to a loss incident date.

The policyHistoryTimestamp indicates at what time was the policy considered authoritative for the given loss. For example, if there was an endorsement in July for a policy that had a May effective date, and you are considering a loss in June, you could set the history timestamp to reflect or exclude the effects of the July endorsement. By default it will be the same as the coverageReferenceTimestamp.

PolicyCoverageSummaryResponse
required
locator string
policyholderLocator string
productName string
coverageReferenceTimestamp timestamp
policyHistoryTimestamp timestamp

optional
ExposureCoverageSummaryResponse
required
locator string
name string
PerilCoverageSummaryResponse
required
locator string
name string
renewalGroup string