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
POST /policies/{policyLocator}/endorsements| Name | Position | Type | Required |
|---|---|---|---|
| endorsementCreateRequest | body | EndorsementCreateRequest | required |
| policyLocator | path | string | required |
EndorsementResponserequiredendorsementName stringoptionalstate string application | quoted | accepted | issuedstartTimestamp timestampnewPolicyEndTimestamp timestampfieldValues map<string,[string]>addFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addExposures [ExposureCreateRequest]updateExposures [EndorsementExposureUpdateRequest]endExposures [string]autofill [string]newPaymentScheduleName stringreprice booleanconflictHandling 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.
requiredlocator stringpolicyholderLocator stringpolicyLocator stringproductLocator stringendorsementName stringstate string application | quoted | accepted | issued | invalidated | discardedcreatedTimestamp timestampupdatedTimestamp timestampdocuments [PolicyDocumentResponse]fieldValues map<string,[string]>addFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addExposures [ExposureCreateResponse]updateExposures [EndorsementExposureUpdateResponse]endExposures [string]reprice booleanoptionalissuedTimestamp timestampstartTimestamp timestampnewPolicyEndTimestamp timestampautomatedUnderwritingResult AutomatedUnderwritingResultResponseinvoice PolicyInvoiceResponsenewPaymentScheduleName stringplannedInvoices [FutureInvoiceResponse]
GET /policies/{policyLocator}/endorsements| Name | Position | Type | Required |
|---|---|---|---|
| policyLocator | path | string | required |
[EndorsementResponse]requiredlocator stringexposureName stringperils [PerilCreateResponse]fieldValues map<string,[string]>exposureLocator stringfieldGroups [FieldGroupCreateRequest]
GET /endorsements/{endorsementLocator}| Name | Position | Type | Required |
|---|---|---|---|
| endorsementLocator | path | string | required |
EndorsementResponseGET /endorsements/{endorsementLocator}/automatedUnderwritingResult| Name | Position | Type | Required |
|---|---|---|---|
| endorsementLocator | path | string | required |
AutomatedUnderwritingResultResponseGET /endorsements/{endorsementLocator}/price| Name | Position | Type | Required |
|---|---|---|---|
| endorsementLocator | path | string | required |
PolicyPriceChangeResponseNote: All pricing or underwriting rules run before acceptance are non-final.
PATCH /endorsements/{endorsementLocator}/update| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponsePATCH /endorsements/{endorsementLocator}/quote| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponsePATCH /endorsements/{endorsementLocator}/accept| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponsePATCH /endorsements/{endorsementLocator}/invalidate| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponsePATCH /endorsements/{endorsementLocator}/discard| Name | Position | Type | Required |
|---|---|---|---|
| endorsementLocator | path | string | required |
EndorsementResponsePATCH /endorsements/{endorsementLocator}/issue| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponseoptionalaction string discard | quote | accept | issue | invalidate | updateendorsementUpdate EndorsementUpdateRequestconflictHandling string block | invalidate
requiredaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]optionalstartTimestamp timestampnewPolicyEndTimestamp timestampfieldValues map<string,[string]>addExposures [ExposureCreateRequest]updateExposures [EndorsementExposureUpdateRequest]endExposures [string]autofill [string]newPaymentScheduleName stringreprice boolean
requiredaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addPerils [PerilCreateRequest]updatePerils [PerilUpdateRequest]endPerils [string]exposureLocator stringoptionalfieldValues map<string,[string]>
GET /endorsements/{endorsementLocator}/policyWhenIssued| Name | Position | Type | Required |
|---|---|---|---|
| endorsementLocator | path | string | required |
PolicyResponseThis 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
PATCH /endorsements/{endorsementLocator}| Name | Position | Type | Required |
|---|---|---|---|
| actionRequest | body | EndorsementActionRequest | required |
| endorsementLocator | path | string | required |
EndorsementResponseThis 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.