Skip to main content

Quote Responses

RequestQuotesRefinementResponse

NameTypeDescription
quotesCorrelationIdguidThe correlation ID that should be used when retrieving quotes from the API.
onlineJourneyUrlstringThe URL used to continue the customer’s journey on the SimplyIOA website.
metadataOrderedMap[string, string]Metadata that can be passed along with the request, and is returned with each response. Can be used for customer specific information.

QuotesRefinementResponse

NameTypeDescription
quotesCorrelationIdguidThe correlation ID that should be used when retrieving quotes from the API.
quotesQuoteAn array of quotes. See the definition of Quote below.
statusMessagestringIf an error has occurred, displays information about the error.
isSuccessfulboolIf the quotes request that this response relates to has been successful. Note: This does not indicate whether or not quotes have been returned, only if there has been an error during quoting.
onlineJourneyUrlstringThe URL used to continue the customer’s journey on the SimplyIOA website.
premiumSummaryPremiumSummaryA summary of the premium details.

QuotesRequestResponse

NameTypeDescription
quotesCorrelationIdguidThe correlation ID that should be used when retrieving quotes from the API.

QuotesResponse

NameTypeDescription
quotesCorrelationIdguidThe correlation ID that should be used when retrieving quotes from the API.
quotesQuoteAn array of quotes. See the definition of Quote below.
statusMessagestringIf an error has occurred, displays information about the error.
isSuccessfulboolIf the quotes request that this response relates to has been successful. Note: This does not indicate whether or not quotes have been returned, only if there has been an error during quoting.

Quote

NameTypeDescription
quoteIdguidThe unique identifier for the quote.
carrierNamestringThe name of the carrier.
premiumDetailsPremiumDetailsThe premium details. See the definition of PremiumDetails below.
carrierLogoUrlstringThe URL to the carrier logo.
carrierLogoThumbnailUrlstringThe URL to the thumbnail version of the carrier logo.

PremiumDetails

NameTypeDescription
termInMonthsintThe number of months for the term of the policy.
premiumdoubleThe total cost of the policy over the term.
monthlyPremiumEstimatedoubleThe monthly cost of the policy.