Getting a Quote
To request a quote, retrieve the product's questions, collect intake answers, and fire a GET_QUOTES event. Use the returned triggerRequestId to retrieve the resulting quotes.
Setup#
- Obtain the product's UUID from the organization providing the product.
- Configure authentication.
- Retrieve the product questions to build your intake form. Refresh the question configuration when the product changes.
The response contains a product tree. Questions are nested under a product's display.sections[].subsections[].questions[]; child products are in lines.
Request and Retrieve Quotes#
- Collect answers using each question's
qid. - Send a GET_QUOTES event to
POST /ioi/v3/event/fire, following the event request envelope. - Save the response's
triggerRequestId. - Retrieve results from
GET /ioi/v3/quotes/trigger/{triggerRequestId}. See Quotes for thequotedanddeclinedresponse arrays and quote fields.
Action execution can continue after an asynchronous event response. An initial quote retrieval can therefore precede completed rating results; retrieve again as required by your integration. The event envelope also supports forceSync; see the event documentation for that option.
For configured outbound notifications, see webhook actions and setting up an action. Notification behavior depends on the product's configured actions.
Use a Returned Quote#
Use the quote's requestId as its identifier in subsequent quote operations. The event type sent to request quotes is GET_QUOTES; "Quote Requested" is its display name.
The quote reference describes retrieval, underwriter decisions, and links to worksheet downloads.