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 an endorsement	PATCH /endorsements/{endorsementLocator}/update
Quote an endorsement	PATCH /endorsements/{endorsementLocator}/quote
Accept an endorsement	PATCH /endorsements/{endorsementLocator}/accept
Invalidate an endorsement	PATCH /endorsements/{endorsementLocator}/invalidate
Discard an endorsement	PATCH /endorsements/{endorsementLocator}/discard
Issue an endorsement	PATCH /endorsements/{endorsementLocator}/issue
Get policy as if the endorsement were issued	GET /endorsements/{endorsementLocator}/policyWhenIssued
Update, accept or issue an endorsement	PATCH /endorsements/{endorsementLocator}

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

Note

Changing the policy end timestamp using an endorsement (setting the newPolicyEndTimestamp property on an EndorsementCreateRequest) is not allowed, unless the relevant feature flag is first enabled for your tenant. See Enabling Extension and Reduction Endorsements for more information.

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 [ExposureCreateResponse]
updateExposures [EndorsementExposureUpdateResponse]
endExposures [string]
reprice boolean

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

List all endorsements for a policy¶

GET /policies/{policyLocator}/endorsements

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [EndorsementResponse]

ExposureCreateResponse¶

required
locator string
exposureName string
perils [PerilCreateResponse]
fieldValues map<string,[string]>
exposureLocator string
fieldGroups [FieldGroupCreateRequest]

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 an endorsement¶

PATCH /endorsements/{endorsementLocator}/update

Request:

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

Response: EndorsementResponse

Quote an endorsement¶

PATCH /endorsements/{endorsementLocator}/quote

Request:

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

Response: EndorsementResponse

Accept an endorsement¶

PATCH /endorsements/{endorsementLocator}/accept

Request:

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

Response: EndorsementResponse

Invalidate an endorsement¶

PATCH /endorsements/{endorsementLocator}/invalidate

Request:

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

Response: EndorsementResponse

Discard an endorsement¶

PATCH /endorsements/{endorsementLocator}/discard

Request:

Name	Position	Type	Required
endorsementLocator	path	string	required

Response: EndorsementResponse

Issue an endorsement¶

PATCH /endorsements/{endorsementLocator}/issue

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
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addPerils [PerilCreateRequest]
updatePerils [PerilUpdateRequest]
endPerils [string]
exposureLocator string

optional
fieldValues map<string,[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

Update, accept or issue an endorsement¶

PATCH /endorsements/{endorsementLocator}

Request:

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

Response: EndorsementResponse

This endpoint consolidating all endorsement actions into a single PATCH call is considered legacy. The same functionality has been split out into individual actions, listed above, and will afford more granular control when using Roles & Permissions.

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