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¶
requiredendorsementName 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.
EndorsementResponse¶
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 [EndorsementExposureUpdateRequest]endExposures [string]reprice booleanoptionalissuedTimestamp timestampstartTimestamp timestampnewPolicyEndTimestamp timestampautomatedUnderwritingResult AutomatedUnderwritingResultResponseinvoice PolicyInvoiceResponsenewPaymentScheduleName stringplannedInvoices [FutureInvoiceResponse]
List all endorsements for a policy¶
GET /policies/{policyLocator}/endorsements
Request:
Name | Position | Type | Required |
---|---|---|---|
policyLocator | path | string | required |
Response:
[EndorsementResponse]
ExposureCreateResponse¶
requiredlocator stringexposureName stringperils [PerilCreateRequest]fieldValues map<string,[string]>exposureLocator stringfieldGroups [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, accept or issue an endorsement¶
PATCH /endorsements/{endorsementLocator}
Request:
Name | Position | Type | Required |
---|---|---|---|
actionRequest | body | EndorsementActionRequest | required |
endorsementLocator | path | string | required |
Response:
EndorsementResponse
EndorsementActionRequest¶
optionalaction string discard | quote | accept | issue | invalidate | updateendorsementUpdate EndorsementUpdateRequestconflictHandling string block | invalidate
EndorsementUpdateRequest¶
requiredaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]optionalstartTimestamp timestampnewPolicyEndTimestamp timestampfieldValues map<string,[string]>addExposures [ExposureCreateRequest]updateExposures [EndorsementExposureUpdateRequest]endExposures [string]autofill [string]newPaymentScheduleName stringreprice boolean
EndorsementExposureUpdateRequest¶
requiredfieldValues 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.