Endorsements API

See the Endorsements Feature Guide for more information about using this feature.

Create an endorsement

POST /policies/{policyLocator}/endorsements

EndorsementCreateRequest

{
  // Required
  endorsementName : string

  // Optional
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  endExposures : [string]
  fieldValues : map<string,[string]>
  newPolicyEndTimestamp : integer
  removeFieldGroups : [string]
  reprice : boolean
  startTimestamp : integer
  state : string application | quoted | accepted | issued
  updateExposures : [EndorsementExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]
}

List all endorsements for a policy

GET /policies/{policyLocator}/endorsements

EndorsementResponse

{
  // Required
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  createdTimestamp : integer
  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 : integer
  updateExposures : [EndorsementExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]

  // Optional
  automatedUnderwritingResult : AutomatedUnderwritingResultResponse
  issuedTimestamp : integer
  newPolicyEndTimestamp : integer
  plannedInvoices : [FutureInvoiceResponse]
  startTimestamp : 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

Fetch the pricing change for an endorsement

GET /endorsements/{endorsementLocator}/price

Note: All pricing or underwriting rules run before acceptance are non-final.

Update, accept or issue an endorsement

PATCH /endorsements/{endorsementLocator}

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 : integer
  removeFieldGroups : [string]
  reprice : boolean
  startTimestamp : integer
  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

PolicyEndorsementIssueRequest

{
  // Required
  endorsementName : string

  // Optional
  newPolicyEndTimestamp : integer
  reprice : boolean
  startTimestamp : integer
}

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

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