Endorsements API

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

Endpoint Index

Action	Endpoint
Create an endorsement	POST /policies/{policyLocator}/endorsements
List all endorsements for a policy	GET /policies/{policyLocator}/endorsements
Fetch an endorsement	GET /endorsements/{endorsementLocator}
Fetch the underwriting decision for an endorsement	GET /endorsements/{endorsementLocator}/automatedUnderwritingResult
Fetch the pricing change for an endorsement	GET /endorsements/{endorsementLocator}/price
Update, accept or issue an endorsement	PATCH /endorsements/{endorsementLocator}
Get policy as if the endorsement were issued	GET /endorsements/{endorsementLocator}/policyWhenIssued

Details

Create an endorsement¶

POST /policies/{policyLocator}/endorsements

Request:

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

Response: EndorsementResponse

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]
updateExposures [EndorsementExposureUpdateRequest]
endExposures [string]
autofill [string]
newPaymentScheduleName string
reprice boolean
conflictHandling string block | invalidate

List all endorsements for a policy¶

GET /policies/{policyLocator}/endorsements

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [EndorsementResponse]

EndorsementResponse¶

required
locator string
policyholderLocator string
policyLocator string
productLocator string
endorsementName string
state string application | quoted | accepted | issued | invalidated | discarded
createdTimestamp timestamp
updatedTimestamp timestamp
documents [PolicyDocumentResponse]
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
updateExposures [EndorsementExposureUpdateRequest]
endExposures [string]
reprice boolean

optional
issuedTimestamp timestamp
startTimestamp timestamp
newPolicyEndTimestamp timestamp
automatedUnderwritingResult AutomatedUnderwritingResultResponse
invoice PolicyInvoiceResponse
newPaymentScheduleName string
plannedInvoices [FutureInvoiceResponse]
price PolicyPriceChangeResponse

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
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]
updateExposures [EndorsementExposureUpdateRequest]
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:

Name	Position	Type	Required
endorsementLocator	path	string	required

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.