{"openapi":"3.1.0","info":{"title":"Eventual Partner API","description":"\n⚠️ This documentation is for reference only.\n\nAll requests must go through the **AWS API Gateway** and include a valid\npartner API key. Direct requests to these endpoints fail with `403 Forbidden`.\n","version":"1.0"},"paths":{"/partner/v1/quotes":{"post":{"tags":["quotes"],"summary":"Create Quote","description":"Create a quote and queue it for pricing.\n\n**With a partner API key:** a quote for the agent named in `agent`.\nReturns **202** immediately with `status: pricing` (or `under_review`\nwhen the agent's email already belongs to a different agency than the one\nnamed, in which case Eventual resolves the attribution by hand before\npricing). Poll `status_url` (or wait for the `quote.completed` webhook)\nfor pricing options, the Premium Lock `short_id`, and the checkout URL.\n\n**Without a key (AI agents):** a direct-to-consumer quote for the person\nin `insured`, whose `email` is required (400 `email_required`). Send no\n`agent` (422). `product_line` defaults to `home`; a line not yet open\nis 409 `line_not_available`. Rate limited per email and per IP (429).\n\nA last-resort carrier is refused (422 `product_line_ineligible`), and so\nis an excess-and-surplus carrier unless `policy.admitted_lines_confirmed`\n(or `auto.admitted_lines_confirmed`) is true.\n\nThe body is taken as raw JSON so the partner adapter's `normalize_request`\nand `map_carrier` hooks run before validation. `Idempotency-Key` is\nrequired (400 without it); the same key with the same body replays the\noriginal 202, and with a different body is refused (422\n`idempotency_key_reused`).","operationId":"create_quote_quotes_post","parameters":[{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Required. A unique value per logical request (at most 255 characters); retries with the same value replay the original response.","title":"Idempotency-Key"},"description":"Required. A unique value per logical request (at most 255 characters); retries with the same value replay the original response."},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Payload"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuoteAccepted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/quotes/batch":{"post":{"tags":["quotes"],"summary":"Create Quote Batch","description":"Create up to 200 quotes in one call.\n\nBody: `{\"quotes\": [<same object as POST /quotes>, ...]}`. Returns 202\nwith one result per item, in order: accepted items carry `quote_id` and\n`status_url` exactly like the single endpoint; invalid items carry\n`errors` and reject only themselves. Resending the batch with the same\n`Idempotency-Key` replays accepted items and re-attempts rejected ones,\nso fix the bad rows and resend the same batch.","operationId":"create_quote_batch_quotes_batch_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":251},{"type":"null"}],"description":"Required. One key for the whole batch; item keys are derived from it, so resending the batch with the same key replays item by item.","title":"Idempotency-Key"},"description":"Required. One key for the whole batch; item keys are derived from it, so resending the batch with the same key replays item by item."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Payload"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBatchQuoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/quotes/{quote_id}":{"get":{"tags":["quotes"],"summary":"Get Quote","description":"Poll a quote.\n\n`status` is `pricing` (queued for, or being priced by, the worker),\n`under_review` (an Eventual admin is resolving the agent's agency by\nhand before it can price), `complete`, or `failed` (with\n`failure_reason`). On `complete` the body carries the purchasable\n`pricing` options in dollars, the Premium Lock `short_id`, `expires_at`,\n`pending_approval`, and the `checkout_url` to hand the agent. A quote that\nbelongs to another partner is a 404, the same as one that does not exist.\n\nWithout a key, only key-less quotes can be read, and the body also says\nhow the consumer may buy: `purchase_options`, the `required_disclosures`\nto show word for word first with the `disclosure_set_id` and\n`disclosure_text_sha256` to echo in the consent, and the\n`documents_needed` after purchase.","operationId":"get_quote_quotes__quote_id__get","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Quote Id"}},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["quotes"],"summary":"Update Quote","description":"Update a quote's policy or insured details and re-price it.\n\nSend only the fields that changed (`policy` in dollars, `insured`,\n`partner_ref`). Returns **202** in the same shape as create: the quote\nkeeps its `quote_id` and `short_id`, goes back to `pricing`, and the\nworker re-prices it; `expires_at` and any large-quote approval are reset\non completion. **409 `quote_purchased`** once the quote has been bought,\n**409 `quote_pricing_in_progress`** while it is being priced (poll, then\nretry). A quote in `under_review` takes the changes but stays in review.\nA previously issued `checkout_url` keeps working and always charges the\ncurrent price. `Idempotency-Key` required, as on create.","operationId":"update_quote_quotes__quote_id__patch","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Quote Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Required. A unique value per logical request (at most 255 characters); retries with the same value replay the original response.","title":"Idempotency-Key"},"description":"Required. A unique value per logical request (at most 255 characters); retries with the same value replay the original response."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Payload"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuoteAccepted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/quotes/{quote_id}/checkout-email":{"post":{"tags":["quotes"],"summary":"Send Checkout Email","description":"Email the consumer their key-less quote with the link to buy it.\n\nGoes to the `insured.email` on the quote, from Eventual. For a consumer\nwho would rather finish later, and the alternative a 429 `daily_cap`\nnames. **409 `quote_not_purchasable`** until the quote is `complete`,\nwhile it awaits approval, once it expires, and once bought. Limited per\nrecipient (429 `rate_limited`). A partner's quote is a 404, and so is any\ncall with a partner key.","operationId":"send_checkout_email_quotes__quote_id__checkout_email_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Quote Id"}},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutEmailSent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/quotes/{quote_id}/purchase":{"post":{"tags":["quotes"],"summary":"Purchase Quote","description":"Buy a key-less quote without leaving the conversation, in two calls.\n\n**Start** with the consumer's `consent` and, if they chose one, the\n`billing_interval`. The consent is recorded and the answer is\n`requires_payment` with the `checkout_url` to show them. A consent to\nany disclosure set but the quote's current one is 409\n`disclosures_changed` with the current set; 422 `terms_version_unknown`\nand `affirmations_required` say what else is missing. A claims answer\n(`no_claims`, or `filed_claim`, its opposite) other than the one the\nquote was priced on is 409\n`claims_answer_mismatch`: create a new quote with `policy.no_claims` set\nto the consumer's answer and buy that one. 409\n`purchase_option_unavailable` while this option is off for the consumer.\n\n**Finish** with the `payment_session_id` the checkout posted back. The\nanswer is `active` once bought, or `pending` while the payment clears\n(send it again shortly). 409 `consent_required` if the purchase was\nnever started, 409 `checkout_attempt_mismatch` for another quote's\nsession, and 409 `purchase_not_activated` when the payment went through\nbut the quote could not go live, so the consumer is owed a refund.\n\nBoth: 409 `quote_not_purchasable` when the quote cannot be bought,\nlimited per email (429), and a 404 for a partner's quote or with a key.","operationId":"purchase_quote_quotes__quote_id__purchase_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Quote Id"}},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/quotes/{quote_id}/claims":{"post":{"tags":["referrals"],"summary":"Add Quote Claim","description":"Attach a referral partner's token to a quote after it was made.\n\nRecords the referrer's claim on the quote, and on every other lock the\nsame quote request made (a bundle's home and cars). A claim says the\nreferrer sent the consumer here; it is not a sale. Each referrer's claim\nis kept, and sending the same token again records nothing new.\n`status` is `recorded`, or `ignored` when the token does not verify\n(tampered, expired, or its referrer is no longer active).\n\nWithout a key, only key-less quotes; with one, only your own (404\n`not_found` otherwise). 409 `quote_purchased` once the quote is bought.","operationId":"add_quote_claim_quotes__quote_id__claims_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Quote Id"}},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteClaimCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteClaimResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/referral-tokens":{"post":{"tags":["referrals"],"summary":"Create Referral Token","description":"Mint a signed referral token for one of your campaigns.\n\n**Referral partners only:** any other key is a 403. Hand the token to the\nconsumers you send us. It comes back as `referral_token` on\n`POST /quotes`, on `POST /quotes/{id}/claims`, or as `?rt=` on the\ncheckout link, and each time records your claim on that quote. The\ntoken is stateless and stops counting at `expires_at`. A claim is\nevidence that you referred the consumer, never proof of a sale: what is\nowed is settled under your agreement.","operationId":"create_referral_token_referral_tokens_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralTokenCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralTokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/documents":{"post":{"tags":["documents"],"summary":"Read Declarations Page","description":"Read a home or car declarations page for the quote it supports.\n\nMultipart: `file` and the consumer's `email` (400 `email_required`).\n`fields` is shaped as the `POST /quotes` body, holding only what the page\nprinted; `missing_required` names what the consumer still has to answer,\nsuch as `insured.email` and `policy.no_claims`. A page that is neither\nline is `product_line: unknown` with an `explanation`. 413\n`document_too_large` over 10 MB, 415 `unsupported_document_type`, 422\n`document_unreadable`, 504 `document_read_timed_out` (send it again).\nWithout a key, 409 `line_not_available` until key-less quoting opens for\nthe consumer, and rate limited per email and per IP (429).","operationId":"read_declarations_page_documents_post","parameters":[{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_read_declarations_page_documents_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/access-requests":{"post":{"tags":["access-requests"],"summary":"Create Access Request Route","description":"Appoint an agency and its roster with Eventual.\n\nSend the agency (your `external_id` for it, its name, phone and licensed\n`states`) and every agent at it with a `role` of `owner`, `admin` or\n`agent`. Returns **202** at once: the request is recorded and processed\nin the background, which creates the agency under your network the first\ntime its `external_id` is seen, creates a login for each agent and emails\nthem the portal invite. Poll `status_url` for the outcome per agent.\n\nThe first request for an agency must include its `owner` (422\n`owner_required`); later requests for the same `external_id` may add\nagents alone. At most 100 agents per request; an agency with more sends\ntwo. Each email may appear once per request. `Idempotency-Key` is\nrequired (400 without it); the same key with the same body replays the\noriginal 202, and with a different body is refused (422\n`idempotency_key_reused`). 409 `partner_not_configured_for_appointments`\nmeans your key is not yet bound to a network on our side.","operationId":"create_access_request_route_access_requests_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Required. A unique value per logical request; retries with the same value replay the original response.","title":"Idempotency-Key"},"description":"Required. A unique value per logical request; retries with the same value replay the original response."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Payload"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccessRequestAccepted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/access-requests/{access_request_id}":{"get":{"tags":["access-requests"],"summary":"Get Access Request Route","description":"Poll an appointment request.\n\n`status` is `processing` until every agent has an outcome, then\n`complete`; `failed` (with `failure_reason`) means the agency itself could\nnot be created and Eventual has been alerted. Each agent is `pending`,\n`invited` (login created, invite emailed), `already_active` (already a\nmember of this agency; nothing sent), `under_review` (the email belongs\nto a member of a different agency; Eventual resolves it by hand, `reason`\nsays so) or `failed` (`reason` says why). `agency.agency_id` and each\nagent's `agent_id` are Eventual's ids once they exist. A request that\nbelongs to another partner is a 404, the same as one that does not exist.","operationId":"get_access_request_route_access_requests__access_request_id__get","parameters":[{"name":"access_request_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Access Request Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccessRequestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/agents/search":{"get":{"tags":["agent directory"],"summary":"Search Agents","description":"Up to five listed independent agents near a ZIP code, one per agency.\n\nNo key and no email needed. Each agent chose to be listed, works at an\nagency that has sold Premium Lock, is licensed in the ZIP's state and\nserves the line. Best first: agents who have sold Premium Lock, have a\nconnected mailbox and are within 25 miles lead (`recommended_agent_id`\nis the first of them, else null), then by distance, Premium Lock sold and\nhow quickly they reply. When nobody is within 50 miles, up to five agents\nlicensed in the state, nearest first, and `searched_area` says so.\n\nShow `notice` with the list. Before asking an agent to email the person,\nshow that agent's `contact_consent.text` word for word.\n\n**422 `location_required`** with no ZIP, **`zip_code_unknown`** for a ZIP\nwe don't know. Open callers are limited to 30 a minute per IP (429\n`rate_limited`).","operationId":"search_agents_agents_search_get","parameters":[{"name":"zip_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"description":"The person's five-digit ZIP code.","title":"Zip Code"},"description":"The person's five-digit ZIP code."},{"name":"product_line","in":"query","required":false,"schema":{"enum":["home","auto","bundle"],"type":"string","description":"`home`, `auto`, or `bundle` (needs both lines).","default":"home","title":"Product Line"},"description":"`home`, `auto`, or `bundle` (needs both lines)."},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/agents/{agent_id}/contact-requests":{"post":{"tags":["agent directory"],"summary":"Create Agent Contact Request","description":"The person asks one agent from `GET /agents/search` to email them.\n\nCall only after the person chose this agent and agreed to the agent's\n`contact_consent.text`, shown word for word: send `consent: true` and that\ntext's `sha256`. Eventual emails the person to confirm first; the agent\nhears nothing until they do. Optionally pass `quote_id` (a quote made for\nthis email) or `quote_inputs` (the `policy` and `auto` blocks `POST\n/quotes` takes), never both.\n\n**404 `agent_not_found`** (not listed, or doesn't serve this ZIP or line),\n**409 `agent_not_accepting_requests`** (weekly cap), **409\n`consent_text_changed`** (show `contact_consent` and ask again), **422\n`quote_source_ambiguous`**, `zip_code_unknown`, `quote_not_yours`, **429\n`rate_limited`** with `retry_after` (3 a day per email, 10 a day and 5 a\nminute per IP), **502 `confirmation_email_failed`** (nothing kept).","operationId":"create_agent_contact_request_agents__agent_id__contact_requests_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentContactRequestCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentContactRequestResponse"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentTextChangedBody"}}},"description":"Conflict"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedBody"}}},"description":"Too Many Requests"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/carriers":{"get":{"tags":["carriers"],"summary":"List Carriers","description":"The carrier values accepted in `policy.carrier_name` on a quote.\n\nIdentical to the public `GET /quoting/carriers`: both are built by\n`quoting.carriers.build_carriers_response` from the enums (EVN-2556), so\npartners and the portal always agree on the list. Canonical, not\nadapter-shaped: a partner adapter that maps its own carrier codes does so\ninbound via `map_carrier`; this list is the target of that mapping.","operationId":"list_carriers_carriers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarriersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/catalog":{"get":{"tags":["catalog"],"summary":"Get Catalog","description":"Marketing's approved description of each product line and of the bundle.\n\nOne entry per (`product_line`, `is_bundle`): the highest approved version,\nwith the `approved_at` it was approved. A line with no approved entry is\nabsent, never placeholder text. Example fees are in dollars. No partner key\nis needed.","operationId":"get_catalog_catalog_get","parameters":[{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/catalog/feeds/openai.json":{"get":{"tags":["catalog"],"summary":"Get Openai Feed","description":"The approved catalog as OpenAI product feed rows, one per line and the bundle.\n\nGenerated from the catalog on every request, so it is a full snapshot. A\nline with no approved entry, or whose examples carry no fee, is absent.\n`price` is the lowest example monthly fee. No partner key is needed.","operationId":"get_openai_feed_catalog_feeds_openai_json_get","parameters":[{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenAIFeedItem"},"title":"Response Get Openai Feed Catalog Feeds Openai Json Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/partner/v1/catalog/feeds/ucp.json":{"get":{"tags":["catalog"],"summary":"Get Ucp Feed","description":"The approved catalog as a UCP catalog response, one product per line and the bundle.\n\nPrices are in cents, as UCP requires. Each product links to its product\npage, where the hosted quote and checkout start. Each disclosure in an\nentry's context is a `disclosure` warning on that product. A line with no\napproved entry, or whose examples carry no fee, is absent. No partner key\nis needed.","operationId":"get_ucp_feed_catalog_feeds_ucp_json_get","parameters":[{"name":"channel_hint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Hint"}},{"name":"x-channel-hint","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Channel-Hint"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UcpFeed"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentContactRequestCreate":{"properties":{"email":{"type":"string","maxLength":255,"format":"email","title":"Email"},"first_name":{"type":"string","maxLength":255,"minLength":1,"title":"First Name"},"last_name":{"type":"string","maxLength":255,"minLength":1,"title":"Last Name"},"zip_code":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Zip Code"},"product_line":{"type":"string","enum":["home","auto","bundle"],"title":"Product Line"},"quote_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Quote Id"},"quote_inputs":{"anyOf":[{"$ref":"#/components/schemas/ContactQuoteInputs"},{"type":"null"}]},"consent":{"type":"boolean","const":true,"title":"Consent"},"consent_text_sha256":{"type":"string","maxLength":64,"minLength":64,"title":"Consent Text Sha256"}},"type":"object","required":["email","first_name","last_name","product_line","consent","consent_text_sha256"],"title":"AgentContactRequestCreate","description":"The person asks one listed agent to email them (plan §4B).\n\n``consent`` must be true and ``consent_text_sha256`` the ``sha256`` of the\nagent's ``contact_consent`` the person agreed to. At most one of\n``quote_id`` (a key-less quote made for this email) and ``quote_inputs``."},"AgentContactRequestResponse":{"properties":{"status":{"type":"string","const":"confirmation_sent","title":"Status"},"sent_to":{"type":"string","title":"Sent To"},"agent_name":{"type":"string","title":"Agent Name"},"agency_name":{"type":"string","title":"Agency Name"},"next_step":{"type":"string","title":"Next Step"}},"type":"object","required":["status","sent_to","agent_name","agency_name","next_step"],"title":"AgentContactRequestResponse","description":"Eventual emailed the person to confirm; the agent hears nothing yet."},"AgentSearchResponse":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/AgentSearchResult"},"type":"array","title":"Agents"},"recommended_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recommended Agent Id"},"searched_area":{"type":"string","title":"Searched Area"},"notice":{"type":"string","title":"Notice"}},"type":"object","required":["recommended_agent_id","searched_area","notice"],"title":"AgentSearchResponse","description":"Up to five agents, one per agency, best first.\n\n``recommended_agent_id`` is the first agent in the preferred tier (sold a\nlock, a connected mailbox, within 25 miles), else null. ``searched_area``\nsays where, and says so when nobody is near and the agents are anywhere in\nthe state. ``notice`` is shown with the list."},"AgentSearchResult":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"agent_name":{"type":"string","title":"Agent Name"},"agency_name":{"type":"string","title":"Agency Name"},"network_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"type":"string","title":"State"},"zip_code":{"type":"string","title":"Zip Code"},"distance_miles":{"type":"integer","title":"Distance Miles"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"type":"string","title":"Email"},"product_lines":{"items":{"type":"string"},"type":"array","title":"Product Lines"},"can_email_you_a_quote":{"type":"boolean","title":"Can Email You A Quote"},"contact_consent":{"$ref":"#/components/schemas/ConsentText"}},"type":"object","required":["agent_id","agent_name","agency_name","network_name","city","state","zip_code","distance_miles","phone","email","product_lines","can_email_you_a_quote","contact_consent"],"title":"AgentSearchResult","description":"One listed agent near the person.\n\n``agent_id`` is the agent's organization membership uuid, the id a\ncontact request names. ``distance_miles`` is straight-line miles from the\nagent's office to the person's ZIP centroid, rounded, at least 1.\n``city`` and ``phone`` are null only when the listing has none.\n``can_email_you_a_quote`` is false once the agent has had their week's\nshare of contact requests."},"AutoPolicyBlock":{"properties":{"carrier_name":{"$ref":"#/components/schemas/CarrierName"},"carrier_friendly_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Carrier Friendly Name"},"state":{"type":"string","maxLength":2,"minLength":2,"title":"State"},"garaging_address":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Garaging Address","description":"Where the cars are kept. On a bundle, the home's address when omitted."},"policy_start_date":{"type":"string","format":"date","title":"Policy Start Date"},"policy_term_months":{"type":"integer","enum":[6,12],"title":"Policy Term Months"},"claims_and_tickets_eligible":{"type":"boolean","title":"Claims And Tickets Eligible","description":"The household's Claims & Tickets Eligibility choice, applied to every car.","default":true},"no_claims":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"No Claims","description":"True for no car insurance claim in the last 12 months. Unanswered prices as no claim."},"business_use_confirmed":{"type":"boolean","title":"Business Use Confirmed","description":"The consumer confirms their policy covers each car's business use. Required when any car's `usage` is `business`.","default":false},"admitted_lines_confirmed":{"type":"boolean","title":"Admitted Lines Confirmed","description":"True when this policy is written on admitted lines. Required for an excess-and-surplus carrier: without it the quote is refused with 422 `product_line_ineligible`. A last-resort carrier is refused either way.","default":false},"vehicles":{"items":{"$ref":"#/components/schemas/AutoVehicleInput"},"type":"array","maxItems":10,"minItems":1,"title":"Vehicles"}},"type":"object","required":["carrier_name","state","policy_start_date","policy_term_months","vehicles"],"title":"AutoPolicyBlock","description":"The auto policy on a key-less auto or bundle quote (plan §4B, PRD R2.3).\n\nMoney in DOLLARS. The policy start date is when the policy term the lock\nstarts on begins, and is held to the same 90-day window as a home renewal."},"AutoVehicleInput":{"properties":{"vin":{"type":"string","maxLength":17,"minLength":1,"title":"Vin"},"allocated_premium":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"}],"title":"Allocated Premium","description":"This car's share of the premium for one policy term, in dollars: the per-vehicle premium the declarations page prints."},"vehicle_year":{"anyOf":[{"type":"integer","maximum":2100.0,"minimum":1900.0},{"type":"null"}],"title":"Vehicle Year"},"vehicle_make":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Vehicle Make"},"vehicle_model":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Vehicle Model"},"usage":{"anyOf":[{"$ref":"#/components/schemas/AutoVehicleUsage"},{"type":"null"}],"description":"How the car is used. A `business` car needs `business_use_confirmed`."}},"type":"object","required":["vin","allocated_premium"],"title":"AutoVehicleInput","description":"One car on a key-less auto quote (premium-lock-agentic plan §4B).\n\nOne car is one Premium Lock, priced from its own share of the policy-term\npremium, as an agent's auto quote is."},"AutoVehicleUsage":{"type":"string","enum":["commute","pleasure","business","farm","other"],"title":"AutoVehicleUsage","description":"How a vehicle is used, as a declarations page classifies it.\n\nNot a pricer input today — ``AutoPricingRequest`` carries no usage field —\nbut it is a rating variable on every real auto filing, so it is stored\nrather than dropped. ``OTHER`` is the escape hatch for a classification\nthis list does not name; a printed usage is never silently discarded.\n\nTyped here rather than beside ``AutoVehicle`` because this module is the\none auto vocabulary file: ``marketplace/models.py`` imports the enums, and\nan import in the other direction would close a cycle (EVN-3318)."},"Body_read_declarations_page_documents_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The page as a PDF, PNG or JPEG."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The consumer's email. Required."}},"type":"object","required":["file"],"title":"Body_read_declarations_page_documents_post"},"CarrierEntry":{"properties":{"carrier_name":{"type":"string","title":"Carrier Name"},"carrier_friendly_name":{"type":"string","title":"Carrier Friendly Name"}},"type":"object","required":["carrier_name","carrier_friendly_name"],"title":"CarrierEntry"},"CarrierName":{"type":"string","enum":["aaa","aegis","acuity","agraria","alfainsurance","alliedtrust","allstate","americaneuropean","americanguaranteeandliability","americanintegrityinsurance","americanmodern","americannational","americanrisk","americanstrategic","americantraditions","amfam","amica","amshield","amwins","andover","arbella","arkansasfarmbureau","assurant","auros","autoowners","bamboo","bearrivermutual","benchmark","bentoakmutual","berkshirehathawayguardinsurancecompanies","berkshirehathwayhomestate","bloomfieldmutual","branch","brethrenmutual","bristolwestinsurance","burnswilcox","cabrillocoastal","cajununderwriters","californiacasualty","celina","centralinsurancecompanies","chubb","cincinnatifinancialgroup","coastal","coloradofarmbureau","connectbyamfam","countryfinancial","csaa","cse","cumberlandmutual","cure","cypress","dairyland","dbinsurance","directauto","donegalgroup","edison","elephant","encompass","enumclaw","erie","esurance","evanston","farmers","farmersunion","farmbureaufinancialservices","fednatinsuranceflorida","firstacceptance","firstcapital","floridafarmbureau","floridapeninsulainsurance","fmne","foremost","fortegra","frankenmuth","franklinmutual","fredloya","frontline","gainsco","geico","georgiafarmbureau","germania","goodvillemutual","goauto","grange","greaternewyorkmutualinsurancecompany","greatnorthwest","gulfstate","hagerty","hanover","hcigroup","henrycountymutual","heritageinsurance","hippo","homeownersofamerica","homesite","homesteadmutual","horacemann","idahofarmbureau","inclinecasualtycompany","indianafarmbureau","integritypc","iowafarmbureau","ironinsurancepartners","kemperauto","kemperpersonalinsurance","kentuckyfarmbureau","kingstone","kininsurance","lemonade","libertymutual","lilypad","loggerhead","louisianafarmbureau","lumenselect","mangrovepropertyinsurancecompany","mapfre","mcmillanwarner","meemic","mercury","metlife","metromile","michiganfarmbureau","midvaleinsuranceauto","midvaleinsurancehome","mississippifarmbureau","missourifarmbureau","mmg","nationalfarmersunion","nationalgeneral","nationwide","njm","northernneck","northcarolinafarmbureau","northstar","nycm","oceanharbor","oldrepublicunion","olympusinsurance","openly","orion180","oswegocountymutual","other","pacificspecialty","patriot","pekininsurance","pemcomutual","pennnational","peoplestrust","pioneer","plymouthrock","praetorian","preferredmutual","progressive","propertyinsurancecompanyamerica","providence","pureinsurance","quincymutual","root","rvos","safeco","safepoint","safetyinsurance","safeway","sagesure","securityfirstflorida","selective","shelter","slideinsurance","southernfarmbureau","southernoakins","southcarolinafarmbureau","stateauto","statefarm","sterling","stillwater","strathmoreinsurancecompany","summitspecialtyinsurancecompany","surechoice","suttonnational","swyfft","tennesseefarmbureau","tesla","texasfarmbureau","thegeneral","thehartford","towerhillinsurance","travelers","trexis","21stcentury","uaic","unionmutual","universalnorthamerica","universalproperty","upcinsurance","usaa","utica","vault","vermontmutual","vyrd","wawanesa","wayne","westchestersurpluslines","westernnational","westfield","westbend","americaninternationalgroup","berkley","brookfieldwealthsolutionsgrp","clearblueinsurance","encova","iatreinsco","kwspecialty","lloyds","mainstreetamerica","markelinsurance","munich","philadelphia","qbe","sh1holdings","tokiomarine","wrightflood","zurich","aiua","cpfa","citizenspropertyinsurance","guaa","illinoisfairplan","louisianacitizens","mbpia","missourifairplan","mjia","mpiua","mrpiua","nccoastalpool","ncjua","newjerseyfair","nypiua","ohiofairplan","rijra","texasfairplan","vpia"],"title":"CarrierName"},"CarriersResponse":{"properties":{"carriers":{"items":{"$ref":"#/components/schemas/CarrierEntry"},"type":"array","title":"Carriers"},"es_carriers":{"items":{"type":"string"},"type":"array","title":"Es Carriers"},"last_resort_carriers":{"items":{"type":"string"},"type":"array","title":"Last Resort Carriers"}},"type":"object","required":["carriers","es_carriers","last_resort_carriers"],"title":"CarriersResponse"},"CatalogEntryResponse":{"properties":{"product_line":{"$ref":"#/components/schemas/ProductLine"},"is_bundle":{"type":"boolean","title":"Is Bundle"},"version":{"type":"integer","title":"Version"},"description":{"type":"string","title":"Description"},"examples":{"items":{"$ref":"#/components/schemas/CatalogExample"},"type":"array","title":"Examples"},"context":{"additionalProperties":true,"type":"object","title":"Context"},"approved_at":{"type":"string","format":"date-time","title":"Approved At"}},"type":"object","required":["product_line","is_bundle","version","description","examples","context","approved_at"],"title":"CatalogEntryResponse","description":"The approved description of one product line, or of the bundle."},"CatalogExample":{"properties":{"monthly_fee":{"type":"number","title":"Monthly Fee","description":"Monthly fee in dollars"},"threshold_percent":{"type":"number","title":"Threshold Percent"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["monthly_fee","threshold_percent"],"title":"CatalogExample"},"CatalogResponse":{"properties":{"entries":{"items":{"$ref":"#/components/schemas/CatalogEntryResponse"},"type":"array","title":"Entries"}},"type":"object","required":["entries"],"title":"CatalogResponse","description":"Every approved entry. A line with nothing approved is absent."},"CheckoutEmailSent":{"properties":{"quote_id":{"type":"string","title":"Quote Id"},"sent_to":{"type":"string","title":"Sent To","description":"The consumer's email on the quote."}},"type":"object","required":["quote_id","sent_to"],"title":"CheckoutEmailSent","description":"`POST /quotes/{quote_id}/checkout-email` 200 body."},"ConsentText":{"properties":{"text":{"type":"string","title":"Text"},"sha256":{"type":"string","title":"Sha256"}},"type":"object","required":["text","sha256"],"title":"ConsentText","description":"The sentence a person agrees to before asking this agent to email them.\n\nShow ``text`` word for word; a contact request echoes ``sha256``."},"ConsentTextChangedBody":{"properties":{"detail":{"type":"string","const":"consent_text_changed","title":"Detail"},"contact_consent":{"$ref":"#/components/schemas/ConsentText"}},"type":"object","required":["detail","contact_consent"],"title":"ConsentTextChangedBody","description":"409 ``consent_text_changed``: show this text and ask again."},"ContactQuoteInputs":{"properties":{"policy":{"anyOf":[{"$ref":"#/components/schemas/PartnerPolicyBlock"},{"type":"null"}]},"auto":{"anyOf":[{"$ref":"#/components/schemas/AutoPolicyBlock"},{"type":"null"}]}},"type":"object","title":"ContactQuoteInputs","description":"The inputs the agent's quote is priced from, when there is no quote_id.\n\nThe same ``policy`` and ``auto`` blocks ``create_quote`` takes\n(``ConsumerQuoteCreate``), so they validate identically: a home request\nsends ``policy``, an auto request ``auto``, a bundle both."},"Disclosure":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"text_sha256":{"type":"string","title":"Text Sha256"}},"type":"object","required":["id","text","text_sha256"],"title":"Disclosure"},"DocumentNeeded":{"type":"string","enum":["declarations_page"],"title":"DocumentNeeded","description":"What the consumer still has to send us after buying."},"DocumentReadResponse":{"properties":{"product_line":{"type":"string","enum":["home","auto","unknown"],"title":"Product Line"},"fields":{"additionalProperties":true,"type":"object","title":"Fields","description":"What the page answered, shaped as the `POST /quotes` body."},"missing_required":{"items":{"type":"string"},"type":"array","title":"Missing Required","description":"Dotted paths into `fields` the consumer still has to answer."},"explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explanation","description":"Why nothing, or only part of the page, was read."}},"type":"object","required":["product_line","fields","missing_required"],"title":"DocumentReadResponse","description":"`POST /documents` (premium-lock-agentic plan §4B, §5C)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"OpenAIFeedItem":{"properties":{"item_id":{"type":"string","minLength":1,"title":"Item Id"},"title":{"type":"string","maxLength":150,"minLength":1,"title":"Title"},"description":{"type":"string","maxLength":5000,"minLength":1,"title":"Description"},"url":{"type":"string","title":"Url"},"brand":{"type":"string","minLength":1,"title":"Brand"},"seller_name":{"type":"string","minLength":1,"title":"Seller Name"},"image_url":{"type":"string","title":"Image Url"},"availability":{"type":"string","enum":["in_stock","out_of_stock","pre_order","backorder","unknown"],"title":"Availability"},"price":{"type":"string","pattern":"^\\d+\\.\\d{2} USD$","title":"Price"},"seller_url":{"type":"string","title":"Seller Url"},"is_eligible_search":{"type":"boolean","title":"Is Eligible Search","default":true},"is_eligible_checkout":{"type":"boolean","title":"Is Eligible Checkout","default":false}},"additionalProperties":false,"type":"object","required":["item_id","title","description","url","brand","seller_name","image_url","availability","price","seller_url"],"title":"OpenAIFeedItem","description":"One feed row: the nine required discovery fields plus the eligibility flags."},"PartnerAccessRequestAccepted":{"properties":{"access_request_id":{"type":"string","title":"Access Request Id"},"status":{"type":"string","const":"processing","title":"Status","default":"processing"},"status_url":{"type":"string","title":"Status Url"},"partner_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Ref"}},"type":"object","required":["access_request_id","status_url"],"title":"PartnerAccessRequestAccepted","description":"The 202 body. The request was recorded; poll `status_url`."},"PartnerAccessRequestAgencyOut":{"properties":{"external_id":{"type":"string","title":"External Id"},"name":{"type":"string","title":"Name"},"agency_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agency Id","description":"Eventual's id for the agency, once it exists."}},"type":"object","required":["external_id","name"],"title":"PartnerAccessRequestAgencyOut"},"PartnerAccessRequestAgentOut":{"properties":{"email":{"type":"string","title":"Email"},"role":{"$ref":"#/components/schemas/PartnerAccessRole"},"status":{"type":"string","enum":["pending","invited","already_active","under_review","failed"],"title":"Status"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id","description":"Eventual's id for the agent's membership of the agency, once one exists (invited or already_active)."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why the agent is under_review or failed; null otherwise."}},"type":"object","required":["email","role","status"],"title":"PartnerAccessRequestAgentOut"},"PartnerAccessRequestResponse":{"properties":{"access_request_id":{"type":"string","title":"Access Request Id"},"status":{"type":"string","enum":["processing","complete","failed"],"title":"Status"},"agency":{"$ref":"#/components/schemas/PartnerAccessRequestAgencyOut"},"agents":{"items":{"$ref":"#/components/schemas/PartnerAccessRequestAgentOut"},"type":"array","title":"Agents"},"partner_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Ref"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"}},"type":"object","required":["access_request_id","status","agency","agents","created_at"],"title":"PartnerAccessRequestResponse","description":"Body of `GET /access-requests/{id}`."},"PartnerAccessRole":{"type":"string","enum":["owner","admin","agent"],"title":"PartnerAccessRole","description":"The role words a partner sends for a roster agent (appointment plan\n§4B); `ACCESS_ROLE_TO_AUTH0_ROLE` maps them onto our role names."},"PartnerBatchQuoteItemResult":{"properties":{"index":{"type":"integer","title":"Index"},"quote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Id"},"status":{"anyOf":[{"$ref":"#/components/schemas/PartnerQuoteStatus"},{"type":"null"}]},"status_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Url"},"partner_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Ref"},"errors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Errors"}},"type":"object","required":["index"],"title":"PartnerBatchQuoteItemResult","description":"One item's outcome in a `POST /quotes/batch` response (EVN-3118).\n\nExactly one of the two shapes: an accepted item carries the same fields\nas the single-quote 202 (`quote_id`…), a rejected one carries `errors`\nin the standard 422 shape. `index` is the item's position in the request,\nso partners can line results up with what they sent."},"PartnerBatchQuoteResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PartnerBatchQuoteItemResult"},"type":"array","title":"Results"},"accepted":{"type":"integer","title":"Accepted"},"rejected":{"type":"integer","title":"Rejected"}},"type":"object","required":["results","accepted","rejected"],"title":"PartnerBatchQuoteResponse","description":"`POST /quotes/batch` 202 body: per-item results plus the tallies."},"PartnerHousehold":{"properties":{"product_line":{"type":"string","enum":["auto","bundle"],"title":"Product Line"},"lines":{"items":{"$ref":"#/components/schemas/PartnerHouseholdLine"},"type":"array","title":"Lines"},"bundle_discount_percent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bundle Discount Percent","description":"The discount a bundle bought on one bill earns, once a priced line carries it. Null for an auto quote."},"required_disclosures":{"anyOf":[{"items":{"$ref":"#/components/schemas/Disclosure"},"type":"array"},{"type":"null"}],"title":"Required Disclosures","description":"A bundle's disclosures, shown word for word before the home and its cars are bought on one bill; null for an auto quote, whose cars use each line's own (EVN-7003)."},"disclosure_set_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disclosure Set Id","description":"Echo in a bundle purchase's consent as `disclosure_set_id`."},"disclosure_text_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disclosure Text Sha256","description":"Echo in a bundle purchase's consent as `disclosure_text_sha256`."}},"type":"object","required":["product_line","lines"],"title":"PartnerHousehold","description":"Every lock one key-less auto or bundle quote created (plan §5B).\n\nAn auto quote is one lock per car; a bundle adds the home. The quote's\n`quote_id` is the home on a bundle and the first car otherwise, and each\nline can be read by its own `quote_id` too."},"PartnerHouseholdLine":{"properties":{"quote_id":{"type":"string","title":"Quote Id"},"product_line":{"type":"string","enum":["home","auto"],"title":"Product Line"},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"The car's VIN; null for home."},"status":{"$ref":"#/components/schemas/PartnerQuoteStatus"},"short_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Id"},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/ProtectionContractBillingInterval"},{"type":"null"}]},"pricing":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartnerPricingOption"},"type":"array"},{"type":"null"}],"title":"Pricing","description":"This lock's own options, once it is priced."},"bundle_recurring_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bundle Recurring Fee","description":"On a bundle, this lock's fee per scheduled payment at `billing_interval` with the bundle discount, in dollars. Null until priced, outside a bundle, and when no discount applies to it."}},"type":"object","required":["quote_id","product_line","status"],"title":"PartnerHouseholdLine","description":"One Premium Lock in a key-less auto or bundle household."},"PartnerPolicyBlock":{"properties":{"full_address":{"type":"string","maxLength":255,"minLength":1,"title":"Full Address"},"carrier_name":{"$ref":"#/components/schemas/CarrierName"},"carrier_friendly_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Carrier Friendly Name"},"total_premium":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"}],"title":"Total Premium","description":"Annual premium in dollars. A new quote above $10,000 is refused with 422 `home_premium_above_maximum`."},"per_incident_limit":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"}],"title":"Per Incident Limit","description":"Dwelling / per-incident coverage limit in dollars"},"deductible":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"}],"title":"Deductible","description":"Deductible in dollars"},"expiry_date":{"type":"string","format":"date","title":"Expiry Date"},"renewal_date":{"type":"string","format":"date","title":"Renewal Date"},"no_claims":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"No Claims"},"admitted_lines_confirmed":{"type":"boolean","title":"Admitted Lines Confirmed","description":"True when this policy is written on admitted lines. Required for an excess-and-surplus carrier: without it the quote is refused with 422 `product_line_ineligible`. A last-resort carrier is refused either way.","default":false}},"type":"object","required":["full_address","carrier_name","total_premium","per_incident_limit","deductible","expiry_date","renewal_date"],"title":"PartnerPolicyBlock","description":"The home-insurance policy being quoted. Money in DOLLARS; dates as\nISO-8601 calendar dates (a policy expires on a day, not at an instant)."},"PartnerPricingOption":{"properties":{"billing_interval":{"$ref":"#/components/schemas/ProtectionContractBillingInterval"},"num_scheduled_payments":{"type":"integer","title":"Num Scheduled Payments"},"recurring_fee":{"type":"number","title":"Recurring Fee","description":"Eventual's fee per scheduled payment, in dollars"},"agent_commission":{"type":"number","title":"Agent Commission","description":"The agent's commission per scheduled payment, in dollars"}},"type":"object","required":["billing_interval","num_scheduled_payments","recurring_fee","agent_commission"],"title":"PartnerPricingOption","description":"One purchasable billing option of a COMPLETE quote, in dollars.\n\nMirrors the portal's `BillingIntervalOption` (what the agent sees on the\nquote page) with the internal fields dropped and cents converted at this\nboundary only."},"PartnerQuoteAccepted":{"properties":{"quote_id":{"type":"string","title":"Quote Id"},"status":{"$ref":"#/components/schemas/PartnerQuoteStatus"},"status_url":{"type":"string","title":"Status Url"},"partner_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Ref"}},"type":"object","required":["quote_id","status","status_url"],"title":"PartnerQuoteAccepted","description":"The 202 body of `POST /quotes` and `PATCH /quotes/{id}` (plan §4A, §5A).\n\nDeliberately small: the row was just enqueued and there is nothing priced\nto show. `status_url` is where to poll; `GET` returns the full\n`PartnerQuoteResponse` once the worker completes (EVN-3079)."},"PartnerQuoteResponse":{"properties":{"quote_id":{"type":"string","title":"Quote Id"},"status":{"$ref":"#/components/schemas/PartnerQuoteStatus"},"status_url":{"type":"string","title":"Status Url"},"partner_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Ref"},"short_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Id"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"checkout_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout Url"},"pending_approval":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pending Approval","description":"True while a large quote (premium at or above Eventual's review threshold) is not yet approved; checkout is blocked until it is."},"pricing":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartnerPricingOption"},"type":"array"},{"type":"null"}],"title":"Pricing"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"purchased_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Purchased At","description":"When the Premium Lock was bought; null until purchase."},"purchased_billing_interval":{"anyOf":[{"$ref":"#/components/schemas/ProtectionContractBillingInterval"},{"type":"null"}],"description":"Which pricing option was bought; null until purchase."},"purchase_options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PurchaseOption"},"type":"array"},{"type":"null"}],"title":"Purchase Options","description":"How the consumer may buy this quote now. Empty until it is complete, while it awaits approval, and once it is bought."},"required_disclosures":{"anyOf":[{"items":{"$ref":"#/components/schemas/Disclosure"},"type":"array"},{"type":"null"}],"title":"Required Disclosures","description":"What the consumer must be shown, word for word, before an in-conversation purchase. Empty when the line has no approved disclosures, and then no in-conversation purchase is offered."},"disclosure_set_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disclosure Set Id","description":"Echo in the purchase consent as `disclosure_set_id`."},"disclosure_text_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disclosure Text Sha256","description":"Echo in the purchase consent as `disclosure_text_sha256`."},"documents_needed":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocumentNeeded"},"type":"array"},{"type":"null"}],"title":"Documents Needed","description":"What the consumer must send after buying. `declarations_page` when the quote was not made from one."},"household":{"anyOf":[{"$ref":"#/components/schemas/PartnerHousehold"},{"type":"null"}],"description":"Key-less auto and bundle quotes: every lock the quote created and its pricing. Null for a home quote."}},"type":"object","required":["quote_id","status","status_url"],"title":"PartnerQuoteResponse","description":"`GET /quotes/{quote_id}` body (plan §4B).\n\nAlways: `quote_id`, `status`, `status_url`, `partner_ref`. On\n`complete`: `short_id` (the Premium Lock ID agents and AMSs use),\n`expires_at`, `checkout_url`, `pending_approval`, `pricing`. On `failed`:\n`failure_reason`. Once bought: `purchased_at`, `purchased_billing_interval`.\nEverything else is null."},"PartnerQuoteStatus":{"type":"string","enum":["pricing","under_review","complete","failed"],"title":"PartnerQuoteStatus","description":"Partner-facing lifecycle words (plan §4B), mapped from the internal\n`ProtectionContractCreationStatus` by `service.partner_status_for`.\n\nMutually exclusive and exhaustive: a quote is in exactly one of these at\nany moment. The two non-terminal words name *who holds the quote* — a\nmachine (``pricing``) or an Eventual human (``under_review``) — because\nthat is what tells a partner whether waiting is enough."},"ProductLine":{"type":"string","enum":["home","auto"],"title":"ProductLine","description":"The product line a contract, parameter or lock belongs to.\n\nDefined here rather than in the renewals ops tool, which is where it\nstarted life with ``HOME`` as its only member. It is now the vocabulary for\nthe whole two-line product: the ops tool's ``ProductParameter.product_line``\nand ``RenewalLock.product_line`` columns, and\n``ProtectionContract.product_line``.\n\n``HOME``'s stored value is ``\"home\"`` and rows already exist carrying it.\nDo not tidy the value.\n\nEvery column typed by this enum declares ``max_length=32`` explicitly, so\nadding a member here needs no migration."},"ProtectionContractBillingInterval":{"type":"string","enum":["monthly","yearly"],"title":"ProtectionContractBillingInterval"},"PurchaseConsentInput":{"properties":{"terms_versions":{"additionalProperties":{"type":"string"},"type":"object","title":"Terms Versions","description":"The Terms of Service version shown for each line bought, e.g. `{\"home\": \"home-2026-07-30\"}`."},"disclosure_set_id":{"type":"string","maxLength":64,"title":"Disclosure Set Id","description":"The quote's `disclosure_set_id`, echoed."},"disclosure_text_sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","title":"Disclosure Text Sha256","description":"The quote's `disclosure_text_sha256`, echoed."},"affirmations":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Affirmations","description":"`admitted_carrier`, `subscription_36_months` and `not_insurance`, each true; the consumer's claims answer, either `filed_claim` (their answer to \"In the last 12 months, have you filed an insurance claim on this insurance policy?\", true for yes) or `no_claims` (true when there was no claim); and optionally `pending_changes`, their answer to \"Do you know of an upcoming insurance renewal offer, insurance price change, or non-renewal on this insurance policy?\" (true for yes)."}},"type":"object","required":["terms_versions","disclosure_set_id","disclosure_text_sha256","affirmations"],"title":"PurchaseConsentInput","description":"What the agent showed the consumer and what they affirmed (plan §4B, PRD R6.1)."},"PurchaseOption":{"type":"string","enum":["checkout_url","checkout_email","shared_payment_token","mcp_app"],"title":"PurchaseOption","description":"How the consumer may buy a key-less quote (premium-lock-agentic plan §4B)."},"PurchaseRequest":{"properties":{"consent":{"anyOf":[{"$ref":"#/components/schemas/PurchaseConsentInput"},{"type":"null"}],"description":"Required to start. When finishing, optional, and it must be the consent given at the start."},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/ProtectionContractBillingInterval"},{"type":"null"}],"description":"When starting, the interval the consumer chose from the quote's `pricing`. Omitted, the quote's own."},"payment_session_id":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^sub_[A-Za-z0-9]+$"},{"type":"null"}],"title":"Payment Session Id","description":"The `session_id` the embedded checkout posted back."},"checkout":{"type":"string","enum":["embedded","hosted"],"title":"Checkout","description":"When starting: `embedded` (the default) answers the embedded checkout the MCP App frames, while `mcp_app` is among the quote's `purchase_options`. `hosted` answers the agent checkout link for the consumer to open and pay on Eventual's site: a payment-only page bound to this consent, the quote and the billing interval (EVN-7001).","default":"embedded"},"household_quote_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":11,"minItems":2},{"type":"null"}],"title":"Household Quote Ids","description":"When starting: to buy several locks of one key-less auto or bundle quote on one payment, every `household.lines[].quote_id` the consumer chose, this quote included. With the home and at least one car of a bundle, they are bought on one bill with the bundle discount, and the consent echoes the household's own `disclosure_set_id` and `disclosure_text_sha256` and names a Terms version for `home` and for `auto`. The consent is checked against, and recorded for, each of them, and the answer is one agent checkout link for them all, so `checkout` must be `hosted`. Omitted, only this quote is bought (EVN-7003)."}},"type":"object","title":"PurchaseRequest","description":"`POST /quotes/{quote_id}/purchase` body (plan §4B, §5D).\n\nWithout ``payment_session_id`` it starts the purchase and needs the\nconsent. With one it finishes the payment the embedded checkout took."},"PurchaseResponse":{"properties":{"status":{"$ref":"#/components/schemas/PurchaseStatus","description":"`requires_payment`: show the consumer `checkout_url`. `pending`: the payment has not cleared yet; send the same call again shortly. `active`: bought."},"quote_id":{"type":"string","title":"Quote Id"},"short_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Id"},"billing_interval":{"$ref":"#/components/schemas/ProtectionContractBillingInterval"},"checkout_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout Url","description":"The embedded checkout to render, while `requires_payment`."},"documents_needed":{"items":{"$ref":"#/components/schemas/DocumentNeeded"},"type":"array","title":"Documents Needed","description":"What the consumer still has to send us after buying."},"dashboard_url":{"type":"string","title":"Dashboard Url","description":"Where the consumer manages the Premium Lock once bought."},"dec_page_upload_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dec Page Upload Url","description":"Where the consumer uploads the declarations page `documents_needed` asks for, once bought; null when none is needed (EVN-7065)."},"household_quote_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Household Quote Ids","description":"Every quote the household purchase covers, this one first; null for a single quote (EVN-7003)."}},"type":"object","required":["status","quote_id","short_id","billing_interval","checkout_url","documents_needed","dashboard_url"],"title":"PurchaseResponse","description":"`POST /quotes/{quote_id}/purchase` 200 body (plan §4B)."},"PurchaseStatus":{"type":"string","enum":["requires_payment","pending","active"],"title":"PurchaseStatus","description":"Where an in-conversation purchase stands (premium-lock-agentic plan §4B)."},"QuoteClaimCreate":{"properties":{"referral_token":{"type":"string","maxLength":1024,"minLength":1,"title":"Referral Token"}},"type":"object","required":["referral_token"],"title":"QuoteClaimCreate","description":"`POST /quotes/{quote_id}/claims` body (premium-lock-agentic plan §4A)."},"QuoteClaimResult":{"properties":{"quote_id":{"type":"string","title":"Quote Id"},"status":{"type":"string","enum":["recorded","ignored"],"title":"Status"}},"type":"object","required":["quote_id","status"],"title":"QuoteClaimResult","description":"`POST /quotes/{quote_id}/claims` 200 body.\n\n`recorded` when the referrer's claim is on the quote, including when the\nsame token was recorded there before. `ignored` when the token did not\nverify (tampered, expired, or its referrer is no longer active); nothing\nis recorded, and why is not said."},"RateLimitedBody":{"properties":{"detail":{"type":"string","const":"rate_limited","title":"Detail"},"retry_after":{"type":"integer","title":"Retry After"}},"type":"object","required":["detail","retry_after"],"title":"RateLimitedBody","description":"429 ``rate_limited``: try again after ``retry_after`` seconds."},"ReferralTokenCreate":{"properties":{"campaign":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._:-]*$","title":"Campaign","description":"Your name for the campaign the token is for, kept on the claim it produces: letters, digits, spaces and `._:-`."}},"type":"object","required":["campaign"],"title":"ReferralTokenCreate","description":"`POST /referral-tokens` body (premium-lock-agentic plan §4A)."},"ReferralTokenResponse":{"properties":{"token":{"type":"string","title":"Token","description":"Pass it on as `referral_token` on `POST /quotes`, on `POST /quotes/{id}/claims`, or as `?rt=` on the checkout link."},"campaign":{"type":"string","title":"Campaign"},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"After this the token is ignored and records no claim."}},"type":"object","required":["token","campaign","expires_at"],"title":"ReferralTokenResponse","description":"`POST /referral-tokens` 201 body."},"UcpAvailability":{"properties":{"available":{"type":"boolean","title":"Available"},"status":{"type":"string","enum":["in_stock","backorder","preorder","out_of_stock","discontinued"],"title":"Status"}},"additionalProperties":false,"type":"object","required":["available","status"],"title":"UcpAvailability"},"UcpDescription":{"properties":{"plain":{"type":"string","minLength":1,"title":"Plain"}},"additionalProperties":false,"type":"object","required":["plain"],"title":"UcpDescription"},"UcpDisclosure":{"properties":{"type":{"type":"string","const":"warning","title":"Type","default":"warning"},"code":{"type":"string","const":"disclosure","title":"Code","default":"disclosure"},"path":{"type":"string","minLength":1,"title":"Path"},"content":{"type":"string","minLength":1,"title":"Content"},"presentation":{"type":"string","const":"disclosure","title":"Presentation","default":"disclosure"}},"additionalProperties":false,"type":"object","required":["path","content"],"title":"UcpDisclosure","description":"A warning the platform must show beside ``path`` and must not dismiss."},"UcpFeed":{"properties":{"ucp":{"$ref":"#/components/schemas/UcpMetadata"},"products":{"items":{"$ref":"#/components/schemas/UcpProduct"},"type":"array","title":"Products"},"messages":{"items":{"$ref":"#/components/schemas/UcpDisclosure"},"type":"array","title":"Messages"}},"additionalProperties":false,"type":"object","required":["ucp","products","messages"],"title":"UcpFeed"},"UcpMedia":{"properties":{"type":{"type":"string","const":"image","title":"Type"},"url":{"type":"string","title":"Url"},"alt_text":{"type":"string","title":"Alt Text"}},"additionalProperties":false,"type":"object","required":["type","url","alt_text"],"title":"UcpMedia"},"UcpMetadata":{"properties":{"version":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"Version"}},"additionalProperties":false,"type":"object","required":["version"],"title":"UcpMetadata"},"UcpPrice":{"properties":{"amount":{"type":"integer","maximum":9007199254740991.0,"minimum":0.0,"title":"Amount"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","title":"Currency"}},"additionalProperties":false,"type":"object","required":["amount","currency"],"title":"UcpPrice"},"UcpPriceRange":{"properties":{"min":{"$ref":"#/components/schemas/UcpPrice"},"max":{"$ref":"#/components/schemas/UcpPrice"}},"additionalProperties":false,"type":"object","required":["min","max"],"title":"UcpPriceRange"},"UcpProduct":{"properties":{"id":{"type":"string","minLength":1,"title":"Id"},"title":{"type":"string","minLength":1,"title":"Title"},"description":{"$ref":"#/components/schemas/UcpDescription"},"url":{"type":"string","title":"Url"},"price_range":{"$ref":"#/components/schemas/UcpPriceRange"},"media":{"items":{"$ref":"#/components/schemas/UcpMedia"},"type":"array","title":"Media"},"variants":{"items":{"$ref":"#/components/schemas/UcpVariant"},"type":"array","minItems":1,"title":"Variants"}},"additionalProperties":false,"type":"object","required":["id","title","description","url","price_range","media","variants"],"title":"UcpProduct"},"UcpSeller":{"properties":{"name":{"type":"string","minLength":1,"title":"Name"}},"additionalProperties":false,"type":"object","required":["name"],"title":"UcpSeller"},"UcpVariant":{"properties":{"id":{"type":"string","minLength":1,"title":"Id"},"title":{"type":"string","minLength":1,"title":"Title"},"description":{"$ref":"#/components/schemas/UcpDescription"},"url":{"type":"string","title":"Url"},"price":{"$ref":"#/components/schemas/UcpPrice"},"availability":{"$ref":"#/components/schemas/UcpAvailability"},"seller":{"$ref":"#/components/schemas/UcpSeller"}},"additionalProperties":false,"type":"object","required":["id","title","description","url","price","availability","seller"],"title":"UcpVariant"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}