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
POST /policies/{policyLocator}/endorsements
Name | Position | Type | Required |
---|---|---|---|
endorsementCreateRequest | body | EndorsementCreateRequest | required |
policyLocator | path | string | required |
EndorsementResponse
requiredendorsementName stringoptionalstate string application | quoted | accepted | issuedstartTimestamp timestampnewPolicyEndTimestamp timestampfieldValues map<string,[string]>addFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addExposures [ExposureCreateRequest]updateExposures [EndorsementExposureUpdateRequest]endExposures [string]newPaymentScheduleName stringreprice booleanconflictHandling string block | invalidate
Note
Prior to version 2031.39, endorsements were required to be effective at midnight based on the tenant’s timezone setting. This restriction has now been removed and endorsements may be made effective at any time of day.
GET /policies/{policyLocator}/endorsements
Name | Position | Type | Required |
---|---|---|---|
policyLocator | path | string | required |
[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 [ExposureCreateRequest]updateExposures [EndorsementExposureUpdateRequest]endExposures [string]reprice booleanoptionalissuedTimestamp timestampstartTimestamp timestampnewPolicyEndTimestamp timestampautomatedUnderwritingResult AutomatedUnderwritingResultResponseinvoice PolicyInvoiceResponsenewPaymentScheduleName stringplannedInvoices [FutureInvoiceResponse]
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.
GET /endorsements/{endorsementLocator}
Name | Position | Type | Required |
---|---|---|---|
endorsementLocator | path | string | required |
EndorsementResponse
GET /endorsements/{endorsementLocator}/automatedUnderwritingResult
Name | Position | Type | Required |
---|---|---|---|
endorsementLocator | path | string | required |
AutomatedUnderwritingResultResponse
GET /endorsements/{endorsementLocator}/price
Name | Position | Type | Required |
---|---|---|---|
endorsementLocator | path | string | required |
PolicyPriceChangeResponse
Note: All pricing or underwriting rules run before acceptance are non-final.
PATCH /endorsements/{endorsementLocator}
Name | Position | Type | Required |
---|---|---|---|
actionRequest | body | EndorsementActionRequest | required |
endorsementLocator | path | string | required |
EndorsementResponse
optionalaction 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]newPaymentScheduleName stringreprice boolean
requiredfieldValues map<string,[string]>addFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addPerils [PerilCreateRequest]updatePerils [PerilUpdateRequest]endPerils [string]exposureLocator string
GET /endorsements/{endorsementLocator}/policyWhenIssued
Name | Position | Type | Required |
---|---|---|---|
endorsementLocator | path | string | required |
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.