Quotes API

Tip

See the Quotes feature topic for more information about quotes.

Fetch all quotes for a policy

GET /policies/{policyLocator}/quotes

PolicyQuoteResponse

{
  // Required
  characteristics : PolicyCharacteristicsResponse
  contractEndTimestamp : timestamp
  contractStartTimestamp : timestamp
  createdTimestamp : timestamp
  documents : [PolicyDocumentResponse]
  exposures : [ExposureResponse]
  fees : [FeeResponse]
  locator : string
  name : string
  policyholderLocator : string
  policyLocator : string
  productLocator : string
  productName : string
  selected : boolean
  state : string draft | quoted | accepted | declined | discarded
  updatedTimestamp : timestamp

  // Optional
  automatedUnderwritingResult : AutomatedUnderwritingResultResponse
  grossFees : number
  grossFeesCurrency : string
  issuedTimestamp : timestamp
  paymentScheduleName : string
}

Fetch a quote

GET /quotes/{quoteLocator}

PolicyQuoteInvoiceResponse

{
  // Required
  endTimestamp : timestamp
  financialTransactions : [FinancialTransactionResponse]
  issueTimestamp : timestamp
  startTimestamp : timestamp
}

Update a draft quote

PATCH /quotes/{quoteLocator}

PolicyQuoteUpdateRequest

{
  // Optional
  addExposures : [ExposureCreateRequest]
  addFieldGroups : [FieldGroupCreateRequest]
  fieldValues : map<string,[string]>
  name : string
  paymentScheduleName : string
  policyEndTimestamp : timestamp
  policyStartTimestamp : timestamp
  removeExposures : [string]
  removeFieldGroups : [string]
  updateExposures : [ExposureUpdateRequest]
  updateFieldGroups : [FieldGroupUpdateRequest]
}

Note

At least one property is required to be set on the PolicyQuoteUpdateRequest

Create a new quote using an existing quote

POST /quotes/{quoteLocator}/createNew

Select a quote

PATCH /quotes/{quoteLocator}/select
  • Request:

    Name

    Position

    Type

    Required

    quoteLocator

    path

    string

    required

  • Response:void

Note

The selected quote is used to determine which quote’s data is sent back with a Policy2Response and which quote is displayed in the UI. It is also the quote that will be bound if the policy is finalized through the /policy API.

Price a quote and lock in details

PATCH /quotes/{quoteLocator}/quote

Fetch pricing for a quote that has already been quoted

GET /quotes/{quoteLocator}/price

Accept a quote

PATCH /quotes/{quoteLocator}/accept

Invalidate a previously accepted quote

PATCH /quotes/{quoteLocator}/invalidate

Discard a quote

PATCH /quotes/{quoteLocator}/discard

QuoteSummaryResponse

{
  // Required
  notDiscarded : [QuoteSummaryResponseItem]
  selected : string
}

QuoteSummaryResponseItem

{
  // Required
  locator : string
  name : string
  state : string draft | quoted | accepted | declined | discarded
}