Endorsements API¶
See the Endorsements Feature Guide for more information about using this feature.
Create an endorsement¶
POST /policies/{policyLocator}/endorsements
Request:
Name
Position
Type
Required
endorsementCreateRequest
body
required
policyLocator
path
string
required
Response:
EndorsementResponse
EndorsementCreateRequest¶
{// RequiredendorsementName : string// OptionaladdExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]fieldValues : map<string,[string]>newPolicyEndTimestamp : integerremoveFieldGroups : [string]reprice : booleanstartTimestamp : integerstate : string application | quoted | accepted | issuedupdateExposures : [EndorsementExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]}
List all endorsements for a policy¶
GET /policies/{policyLocator}/endorsements
Request:
Name
Position
Type
Required
policyLocator
path
string
required
Response:
[EndorsementResponse]
EndorsementResponse¶
{// RequiredaddExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]createdTimestamp : integerdocuments : [PolicyDocumentResponse]endExposures : [string]endorsementName : stringfieldValues : map<string,[string]>locator : stringpolicyholderLocator : stringpolicyLocator : stringproductLocator : stringremoveFieldGroups : [string]reprice : booleanstate : string application | quoted | accepted | issued | invalidated | discardedupdatedTimestamp : integerupdateExposures : [EndorsementExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]// OptionalautomatedUnderwritingResult : AutomatedUnderwritingResultResponseinvoice : PolicyInvoice2ResponseissuedTimestamp : integernewPolicyEndTimestamp : integerplannedInvoices : [FutureInvoiceResponse]price : PolicyPriceChangeResponsestartTimestamp : integer}
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
required
endorsementLocator
path
string
required
Response:
EndorsementResponse
EndorsementActionRequest¶
{// Optionalaction : string discard | quote | accept | issue | invalidate | updateconflictHandling : string block | invalidateendorsementUpdate : EndorsementUpdateRequest}
EndorsementUpdateRequest¶
{// OptionaladdExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]fieldValues : map<string,[string]>newPolicyEndTimestamp : integerremoveFieldGroups : [string]reprice : booleanstartTimestamp : integerupdateExposures : [EndorsementExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]}
EndorsementExposureUpdateRequest¶
{// RequiredaddFieldGroups : [FieldGroupCreateRequest]addPerils : [PerilCreateRequest]endPerils : [string]exposureLocator : stringfieldValues : map<string,[string]>removeFieldGroups : [string]updateFieldGroups : [FieldGroupUpdateRequest]updatePerils : [PerilUpdateRequest]}
Return policy with accepted transaction as issued.¶
GET /endorsements/{endorsementLocator}/policyWhenIssued
Request:
Name
Position
Type
Required
endorsementLocator
path
string
required
Response:
Policy2Response
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 Endorsement API (Deprecated)¶
The following endpoint will create and issue an endorsement in one shot. This endpoint is deprecated and may be removed in a future release.
Issue an endorsement¶
POST /policy/{policyLocator}/endorse
Request:
Name
Position
Type
Required
policyLocator
path
string
required
request
body
required
Response:
Policy2Response
PolicyEndorsementIssueRequest¶
{// RequiredendorsementName : string// OptionalnewPolicyEndTimestamp : integerreprice : booleanstartTimestamp : integerupdatePolicy : EndorsementPolicyUpdateRequest}
EndorsementPolicyUpdateRequest¶
{// RequiredaddExposures : [ExposureCreateRequest]addFieldGroups : [FieldGroupCreateRequest]endExposures : [string]removeFieldGroups : [string]updateExposures : [EndorsementExposureUpdateRequest]updateFieldGroups : [FieldGroupUpdateRequest]// OptionalfieldValues : map<string,[string]>}
Preview Endorsement Price¶
POST /policy/{policyLocator}/previewEndorsementPrice
Request:
Name
Position
Type
Required
policyLocator
path
string
required
request
body
required
Response:
PolicyPriceChangeResponse
This endpoint will price a prospective endorsement without actually creating or issuing it.