Skip to navigation

start_quote_request

View as Markdown

Starts one quote request for one person and one line. It returns at once with the request in_progress, and carriers answer in the background. Follow the request with get_quote_request. Send only facts the person gave you. Put them in application, in the shape of the required_facts_schema that get_capabilities gives for the line. If a required fact is missing, the answer is a needs_information error that lists each missing field. Ask the person, then send the request again. consent_receipt_id is required: the ID of the person’s consent for Truvo to get quotes for them. It covers quoting only. For auto only, send credit_disclosure_receipt_id when the person agreed to a credit check. Renters and pet requests do not use it. Set a contact channel to true only when contact_consent, the person’s own record of consent to be contacted, lists that channel in its channels. Each receipt covers one consent. Never send one receipt ID in two fields, and never make a receipt up. request_key is your own ID for this request. The same key with the same input returns the same request, so a retry never starts a second one. A key that already started a request cannot take different input, so use a new key for a new request. Leave out scenario unless the person or developer asks to test a named sandbox outcome, and never send it on a first quote. The line’s default scenario prices whatever pets, drivers, or vehicles you send.

  • Title: Request insurance quotes
  • Callers: partner key, platform key, and keyless
  • Hints: readOnlyHint: false, destructiveHint: false
  • Result: The quote request, with the status in_progress. With a platform key or keyless, it also holds read_handle and read_handle_expires_at. Keyless, it also holds quote_consent, the receipt that Truvo recorded.
  • HTTP: POST /v1/quote-requests
FieldTypeRequiredDescription
linestringYesThe insurance line. One of personal_auto, renters, or pet.
consent_receipt_idstringYesPartner key and platform key only. The ID of the person’s consent for Truvo to get quotes for them.
credit_disclosure_receipt_idstringNoPartner key and platform key only. For auto, the ID of the person’s agreement to a credit check.
contact_consentobjectNoPartner key and platform key only. The person’s record of consent to be contacted: its receipt_id and the channels it covers.
contact_channelsobjectNoPartner key and platform key only. The email, sms, and phone channels, each true or false. Set a channel to true only if contact_consent lists it.
scenariostringNoSandbox only. The scenario that decides the outcome. Leave it out unless you test a named outcome.
request_keystringYesYour own ID for this request. Send a new random UUID for each new request, and the same value to retry it.
applicationobjectYesThe person’s facts, in the shape of the line’s required_facts_schema from get_capabilities.
quote_disclosure_versionstringYesKeyless only. The version of the quote disclosure from get_capabilities that the person agreed to.
quote_disclosure_acceptedbooleanYesKeyless only. true once the person agrees to the quote disclosure.

Try it

POST
https://api.truvo.com/v1/mcp#start_quote_request
Headers
Body