Endorsements API

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

Create an endorsement

POST /policies/{policyLocator}/endorsements

Request:

Name	Position	Type	Required
endorsementCreateRequest	body	EndorsementCreateRequest	required
policyLocator	path	string	required

Response: EndorsementResponse

EndorsementCreateRequest

required
endorsementNamestring

optional
addExposures[ExposureCreateRequest]
addFieldGroups[FieldGroupCreateRequest]
conflictHandlingstring block | invalidate
endExposures[string]
fieldValuesmap<string,[string]>
newPaymentScheduleNamestring
newPolicyEndTimestamptimestamp
removeFieldGroups[string]
repriceboolean
startTimestamptimestamp
statestring application | quoted | accepted | issued
updateExposures[EndorsementExposureUpdateRequest]
updateFieldGroups[FieldGroupUpdateRequest]

List all endorsements for a policy

GET /policies/{policyLocator}/endorsements

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [EndorsementResponse]

EndorsementResponse

required
addExposures[ExposureCreateRequest]
addFieldGroups[FieldGroupCreateRequest]
createdTimestamptimestamp
documents[PolicyDocumentResponse]
endExposures[string]
endorsementNamestring
fieldValuesmap<string,[string]>
locatorstring
policyholderLocatorstring
policyLocatorstring
productLocatorstring
removeFieldGroups[string]
repriceboolean
statestring application | quoted | accepted | issued | invalidated | discarded
updatedTimestamptimestamp
updateExposures[EndorsementExposureUpdateRequest]
updateFieldGroups[FieldGroupUpdateRequest]

optional
automatedUnderwritingResultAutomatedUnderwritingResultResponse
invoicePolicyInvoice2Response
issuedTimestamptimestamp
newPaymentScheduleNamestring
newPolicyEndTimestamptimestamp
plannedInvoices[FutureInvoiceResponse]
pricePolicyPriceChangeResponse
startTimestamptimestamp

Note

When a payment plan change is part of the endorsement, the array of plannedInvoices may not fully reflect the change. This is a known issue which will be fixed in an upcoming release.

Fetch an endorsement

GET /endorsements/{endorsementLocator}

Request:

Name	Position	Type	Required
endorsementLocator	path	string	required

Response: EndorsementResponse

Fetch the underwriting decision for an endorsement

GET /endorsements/{endorsementLocator}/automatedUnderwritingResult

Request:

Name	Position	Type	Required
endorsementLocator	path	string	required

Response: AutomatedUnderwritingResultResponse

Fetch the pricing change for an endorsement

GET /endorsements/{endorsementLocator}/price

Request:

Name	Position	Type	Required
endorsementLocator	path	string	required

Response: PolicyPriceChangeResponse

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

Update, accept or issue an endorsement

PATCH /endorsements/{endorsementLocator}

Request:

Name	Position	Type	Required
actionRequest	body	EndorsementActionRequest	required
endorsementLocator	path	string	required

Response: EndorsementResponse

EndorsementActionRequest

optional
actionstring discard | quote | accept | issue | invalidate | update
conflictHandlingstring block | invalidate
endorsementUpdateEndorsementUpdateRequest

EndorsementUpdateRequest

required
addFieldGroups[FieldGroupCreateRequest]
removeFieldGroups[string]
updateFieldGroups[FieldGroupUpdateRequest]

optional
addExposures[ExposureCreateRequest]
endExposures[string]
fieldValuesmap<string,[string]>
newPaymentScheduleNamestring
newPolicyEndTimestamptimestamp
repriceboolean
startTimestamptimestamp
updateExposures[EndorsementExposureUpdateRequest]

EndorsementExposureUpdateRequest

required
addFieldGroups[FieldGroupCreateRequest]
addPerils[PerilCreateRequest]
endPerils[string]
exposureLocatorstring
removeFieldGroups[string]
updateFieldGroups[FieldGroupUpdateRequest]
updatePerils[PerilUpdateRequest]

optional
fieldValuesmap<string,[string]>

Get policy as if the endorsement were issued

GET /endorsements/{endorsementLocator}/policyWhenIssued

Request:

Name	Position	Type	Required
endorsementLocator	path	string	required

Response: Policy2Response

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 Endorsement API (Deprecated)

The following endpoint will create and issue an endorsement in one shot. This endpoint is deprecated and may be removed in a future release.

Issue an endorsement

POST /policy/{policyLocator}/endorse

Request:

Name	Position	Type	Required
policyLocator	path	string	required
request	body	PolicyEndorsementIssueRequest	required

Response: Policy2Response

PolicyEndorsementIssueRequest

required
endorsementNamestring

optional
newPolicyEndTimestamptimestamp
repriceboolean
startTimestamptimestamp
updatePolicyEndorsementPolicyUpdateRequest

EndorsementPolicyUpdateRequest

required
addExposures[ExposureCreateRequest]
addFieldGroups[FieldGroupCreateRequest]
endExposures[string]
removeFieldGroups[string]
updateExposures[EndorsementExposureUpdateRequest]
updateFieldGroups[FieldGroupUpdateRequest]

optional
fieldValuesmap<string,[string]>
newPaymentScheduleNamestring

Preview Endorsement Price

POST /policy/{policyLocator}/previewEndorsementPrice

Request:

Name	Position	Type	Required
policyLocator	path	string	required
request	body	PolicyEndorsementIssueRequest	required

Response: PolicyPriceChangeResponse

This endpoint will price a prospective endorsement without actually creating or issuing it. Note: locators for newly added exposures and perils are transient and will be different from those that would be created if the endorsement were actually created.