Endorsements API

See the Endorsements Feature Guide for more information about using this feature.

Endpoint Index

ActionEndpoint
Create an endorsementPOST /policies/{policyLocator}/endorsements
List all endorsements for a policyGET /policies/{policyLocator}/endorsements
Fetch an endorsementGET /endorsements/{endorsementLocator}
Fetch the underwriting decision for an endorsementGET /endorsements/{endorsementLocator}/automatedUnderwritingResult
Fetch the pricing change for an endorsementGET /endorsements/{endorsementLocator}/price
Update, accept or issue an endorsementPATCH /endorsements/{endorsementLocator}
Get policy as if the endorsement were issuedGET /endorsements/{endorsementLocator}/policyWhenIssued

Details

Create an endorsement
POST /policies/{policyLocator}/endorsements
EndorsementCreateRequest
required
endorsementName string

optional
state string application | quoted | accepted | issued
startTimestamp timestamp
newPolicyEndTimestamp timestamp
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
endExposures [string]
autofill [string]
newPaymentScheduleName string
reprice boolean
conflictHandling string block | invalidate
List all endorsements for a policy
GET /policies/{policyLocator}/endorsements
    Request:
    NamePositionTypeRequired
    policyLocatorpathstringrequired
EndorsementResponse
required
locator string
policyholderLocator string
policyLocator string
productLocator string
endorsementName string
state string application | quoted | accepted | issued | invalidated | discarded
createdTimestamp timestamp
updatedTimestamp timestamp
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
endExposures [string]
reprice boolean

optional
issuedTimestamp timestamp
startTimestamp timestamp
newPolicyEndTimestamp timestamp
automatedUnderwritingResult AutomatedUnderwritingResultResponse
newPaymentScheduleName string
plannedInvoices [FutureInvoiceResponse]
Fetch an endorsement
GET /endorsements/{endorsementLocator}
    Request:
    NamePositionTypeRequired
    endorsementLocatorpathstringrequired
Fetch the underwriting decision for an endorsement
GET /endorsements/{endorsementLocator}/automatedUnderwritingResult
Fetch the pricing change for an endorsement
GET /endorsements/{endorsementLocator}/price

Note: All pricing or underwriting rules run before acceptance are non-final.

Update, accept or issue an endorsement
PATCH /endorsements/{endorsementLocator}
EndorsementActionRequest
optional
action string discard | quote | accept | issue | invalidate | update
endorsementUpdate EndorsementUpdateRequest
conflictHandling string block | invalidate
EndorsementUpdateRequest
required
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]

optional
startTimestamp timestamp
newPolicyEndTimestamp timestamp
fieldValues map<string,[string]>
addExposures [ExposureCreateRequest]
endExposures [string]
autofill [string]
newPaymentScheduleName string
reprice boolean
EndorsementExposureUpdateRequest
required
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addPerils [PerilCreateRequest]
updatePerils [PerilUpdateRequest]
endPerils [string]
exposureLocator string
Get policy as if the endorsement were issued
GET /endorsements/{endorsementLocator}/policyWhenIssued
    Request:
    NamePositionTypeRequired
    endorsementLocatorpathstringrequired
    Response: PolicyResponse

This endpoint will return what the policy will look like, including pricing and characteristics, assuming the endorsement is issued. It will only work on accepted endorsements.

Legacy Endorsements

See the Legacy Endorsements topic for information on older endorsement functionality.