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	EndorsementCreateRequest	required
  policyLocator	path	string	required

• Response:EndorsementResponse

EndorsementCreateRequest

{
  // Required
  endorsementName : string

  // Optional
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  fieldValues : map<string,[string]>
  newPolicyEndTimestamp : timestamp
  removeFieldGroups : [string]
  reprice : boolean
  startTimestamp : timestamp
  state : string application | quoted | accepted | issued
  updateExposures : [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

{
  // Required
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  createdTimestamp : timestamp
  documents : [PolicyDocumentResponse]
  endExposures : [string]
  endorsementName : string
  fieldValues : map<string,[string]>
  locator : string
  policyholderLocator : string
  policyLocator : string
  productLocator : string
  removeFieldGroups : [string]
  reprice : boolean
  state : string application | quoted | accepted | issued | invalidated | discarded
  updatedTimestamp : timestamp
  updateExposures : [EndorsementExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  automatedUnderwritingResult : AutomatedUnderwritingResultResponse
  invoice : PolicyInvoice2Response
  issuedTimestamp : timestamp
  newPolicyEndTimestamp : timestamp
  plannedInvoices : [FutureInvoiceResponse]
  price : PolicyPriceChangeResponse
  startTimestamp : timestamp
}

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

{
  // Optional
  action : string discard | quote | accept | issue | invalidate | update
  conflictHandling : string block | invalidate
  endorsementUpdate : EndorsementUpdateRequest
}

EndorsementUpdateRequest

{
  // Optional
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  fieldValues : map<string,[string]>
  newPolicyEndTimestamp : timestamp
  removeFieldGroups : [string]
  reprice : boolean
  startTimestamp : timestamp
  updateExposures : [EndorsementExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]
}

EndorsementExposureUpdateRequest

{
  // Required
  addFieldGroups : [FieldGroupCreateRequest]
  addPerils : [PerilCreateRequest]
  endPerils : [string]
  exposureLocator : string
  fieldValues : 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	PolicyEndorsementIssueRequest	required

• Response:Policy2Response

PolicyEndorsementIssueRequest

{
  // Required
  endorsementName : string

  // Optional
  newPolicyEndTimestamp : timestamp
  reprice : boolean
  startTimestamp : timestamp
  updatePolicy : EndorsementPolicyUpdateRequest
}

EndorsementPolicyUpdateRequest

{
  // Required
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  removeFieldGroups : [string]
  updateExposures : [EndorsementExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  fieldValues : map<string,[string]>
}

Preview Endorsement Price

POST /policy/{policyLocator}/previewEndorsementPrice

• Request:

  Name	Position	Type	Required
  policyLocator	path	string	required
  request	body	PolicyEndorsementIssueRequest	required

• Response:PolicyPriceChangeResponse

This endpoint will price a prospective endorsement without actually creating or issuing it.