Modifications

Modifications are objects that represent changes from the policy due to policy transactions. Every time one of these policy transactions is executed, a modification object will be created to contain important information about what has changed.

Modifications make it easy to see a history of a policy’s transactions. For example, you can take a policy’s policy modifications, order them by either effectiveTimestamp or issuedTimestamp, and enumerate them in a view for users.

Also, modifications give context to individual characteristics to help understand which policy transaction caused characteristics to change.

Data Types

Each primary policy object (a policy, exposure, or peril) has a set of corresponding modification objects as follows:

Primary Objects and Modifications

Primary Object	Modification Object
PolicyResponse	PolicyModificationResponse
ExposureResponse	ExposureModificationResponse
PerilResponse	PerilModificationResponse

Policy Modification Names

The policy modification has a name, which depends on the type of the transaction, as follows:

Policy Modification Names

Transaction	Policy Modification Name
Policy Creation	modification.policy.create
Renewal	modification.policy.renew
Cancellation	modification.policy.cancel
Withdrawal	modification.policy.withdraw
Lapse	modification.policy.lapse
Reinstatement	modification.policy.reinstate
Endorsement	Based on the name of the endorsement type

Note

When modifications are returned in an array as part of the PolicyResponse, they are ordered by their creation timestamp. This ordering is deterministic.