Quotes

Fire a GET_QUOTES event to generate quotes. The Quotes reference documents individual quote retrieval, query parameters, underwriter decisions, and the current response fields.

You can retrieve a list of quotes resulting from a GET_QUOTES event by providing its triggerRequestId. Each quote is identified by requestId.

GET https://api.{ENV}.dais.com/ioi/v3/quotes/trigger/{triggerRequestId}

curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/quotes/trigger/<UUID of the trigger request ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>'

{
  "quoted": [
    {
      "requestId": "<UUID of the quote request ID>",
      "pipelineId": "<UUID of the pipeline ID>",
      "triggerRequestId": "<UUID of the trigger request ID>",
      "quoteTimestamp": "2022-05-24T19:04:24.1Z",
      "quotingOrganization": "<Quoting organization name>",
      "quoteDetails": {
        "premium": {
          "amount": 3945.0,
          "per": "YEAR"
        },
        "duration": {
          "length": 12,
          "scale": "MONTH"
        },
        "coverageTypes": [
          {
            "coverages": [
              {
                "details": {}
              }
            ]
          }
        ],
        "expirationDate": "2022-06-24T19:04:24.183Z"
      },
      "messages": [],
      "bindable": true,
      "effectiveDate": "2022-05-25",
      "type": "QUOTE",
      "lineId": "<UUID of the product ID>",
      "lineName": "<Product name>",
      "clientId": "<UUID of the client ID>",
      "clientOrganizationId": "<UUID of the client organization ID>",
      "quotingOrganizationId": "<UUID of the quoting organization ID>",
      "actionId": "<UUID of the action ID>",
      "metadata": {
        "rateMeta": {
          "<Rating metadata key 1>": "49.08",
          "<Rating metadata key 2>": "60.0"
        }
      },
      "rawQuoteRequest": {},
      "rawQuoteDetails": {},
      "asRatingConfiguredAtTimestamp": "2022-05-24T19:04:24.1Z"
    }
  ],
  "declined": []
}

Response Fields#

Property	Description
`quoted`	Array of quote requests that were successfully quoted
`declined`	Array of quote requests that were declined or failed to quote

Quote object fields:

Property	Description
`requestId`	UUID representing an individual quote. Use this ID when firing the `PAYMENT_SETUP` event.
`triggerRequestId`	UUID representing the `GET_QUOTES` event that generated these quotes.
`pipelineId`	For internal use
`quoteTimestamp`	Timestamp showing when the quote was generated
`quotingOrganization`	Organization that owns the line
`quoteDetails`	Quote details returned from the quote request. Explained in detail below
`bindable`	Boolean representation of whether the quote is bindable
`messages`	This field is sometimes used to return errors or other messages
`effectiveDate`	Date when the policy would go into effect if purchased
`type`	Quote type, such as `QUOTE`, `ENDORSEMENT`, `RENEWAL`, or `DECLINE`. See the full enum
`lineId`	UUID ID of the product for which this quote was generated
`lineName`	Name of the product
`clientId`	UUID ID of the client on whose behalf the quote was requested
`clientOrganizationId`	UUID ID of the organization requesting the quote
`quotingOrganizationId`	UUID of the organization providing the quote.
`actionId`	For internal use
`metadata`	Quote metadata
`asRatingConfiguredAtTimestamp`	Timestamp of the rating configuration used to generate the quote

Quote details fields:

Property	Description
`premium`	Quoted policy premium
`duration`	Quoted policy duration
`coverageTypes`	Coverages included in the quote
`expirationDate`	Timestamp after which the quote will no longer be valid

Download Advanced Rating Worksheet PDF#

For quotes generated by an advanced rating algorithm, you can download the rating worksheet as a PDF. Use the quote requestId returned from the quote response as the quoteId path parameter.

GET https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/{quoteId}/pdf

curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/<UUID of the quote request ID>/pdf?verbose=false' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--output advanced-rating-worksheet.pdf

Path parameters:

Property	Required	Description
`quoteId`	Yes	UUID of the quote to download a worksheet for

Query parameters:

Property	Required	Default	Description
`verbose`	No	`false`	When `false`, returns the coverage worksheet view with rating values. When `true`, returns the full advanced rating algorithm worksheet.

Response:

The response body is a PDF file.

Header	Value
`Content-Type`	`application/pdf`

This endpoint is only available for quotes rated with the advanced algorithm worksheet flow.