Patch and optionally submit a first-party homeowners or umbrella intake.

Applies top-level intake edits for the consumer-prefill follow-up API. Authenticate with Authorization: Bearer <intake_access_token> from the latest consumer-prefill follow-up response. Use this after gathering context-backed answers; for homeowners, recover core shopper and occupancy facts from user-controlled context first, then let Coverage Cat carry estimated home-editor fields into one final review card. After a homeowners application is submitted, this same patch route can answer messy carrier or shopper follow-up in-thread with message_reply; when GET /api/intake/{uid}/issues shows conversation.reply_pending, echo the answer here and pass reply_to_message_id from that conversation payload when Coverage Cat returned one. For umbrella, use the staged review turn to send the bundled shopper-owned details and any corrections, then set confirm_submission: true on that same final turn. Use canonical umbrella count corrections such as umbrella_details.motorized_vehicle_count, never send vehicles rows on this pre-submit patch, and omit top-level field_estimates unless you are certain each field path matches a current umbrella review field. Until that final submit happens, say explicitly that the application is not submitted yet, ask for any remaining items in plain English, and present gathered details plus remaining items as short labeled bullets or sections rather than a prose paragraph. If any shown value is estimated, mark each estimated bullet label or value with *, include the short note * = estimated once above and once below the list, and do not prefix every estimated line with [Estimated]. If the staged review shows a wrong estimated umbrella count from context, patch the canonical umbrella_details.* count field before you show the final review. Coverage Cat will not resume or expose a prior consumer umbrella draft based on email alone. Continue an existing consumer draft only through the issued uid plus the current hidden MCP session or latest intake_access_token handoff. Normalize shopper birthdays from MM-DD-YYYY to YYYY-MM-DD before you send them. Reserve a single human interruption for the final review-and-submit step, keep umbrella credit consent out of this turn, and keep offer selection and post-choose bind continuation on the dedicated /select, /bind, and /attach routes.

patch/api/intake/{uid}

Request

  • Base URL: https://api.coveragecat.com
  • URL: https://api.coveragecat.com/api/intake/{uid}
  • Auth: HTTP bearer

Path parameters

uidstring required

Coverage Cat intake uid returned by the consumer-prefill or intake creation step.

Headers

Coverage-Cat-API-Version'v1'

Optional explicit Coverage Cat API version selector. Omit the header to use the current stable version.

Idempotency-Keystring

Optional idempotency key for consumer or operator write requests. Coverage Cat replays the cached successful response for the same subject, path, and key for 24 hours, and rejects a changed payload under the same key.

Request body

confirm_submissionboolean

Set to true on the single human review turn once the user has reviewed the application and wants Coverage Cat to submit now. Homeowners also require credit_check_authorized: true on that same final turn; umbrella consent for a soft credit check is collected later at select.

current_auto_coverages'unsure' | '500k/1m' | '500k/500k' | '300k/300k' | '100k/300k'

Band for the shopper's current underlying auto liability limits: unsure means I'm not sure; 500k/1m means $500k/$1 Million/$100k or higher; 500k/500k means $500k/$500k/$100k or $500k CSL; 300k/300k means $250k/$500k/$100k or $300k/$300k/$100k or $300k CSL; 100k/300k means $100k/$300k/$100k or lower. Choose the strongest band the shopper's actual limits fully satisfy. Underlying auto limits gate umbrella eligibility, so reserve unsure for limits the shopper genuinely does not know.

message_replystring

Homeowners post-submit only. Send the reply text Coverage Cat should deliver in-thread when the latest issues payload shows conversation.reply_pending, such as answering a carrier underwriting question.

reply_to_message_idinteger

Optional homeowners post-submit target from conversation.messages[].message_id. Use it when Coverage Cat returned a specific follow-up message to answer in-thread.

Response

Patch accepted. The response either reflects the updated review checkpoint or the post-submit quote-progress state.

poll_after_secondsinteger
detail_status'abandoned' | 'blocked' | 'bound' | 'cancelled' | 'chosen' | 'credit_consent_pending' | 'credit_consent_required' | 'dev_success' | 'documents_needed' | 'documents_pending_review' | 'email_sent' | 'in_review' | 'ineligible' | 'info_requested' | 'needs_more_info' | 'needs_more_info_to_bind' | 'no_policy' | 'no_chosen_offer' | 'no_quotes' | 'no_selection' | 'ok' | 'payment_collection_ready' | 'payment_needed' | 'pending' | 'pending_quotes' | 'queued' | 'quote_rate_limited' | 'quoted' | 'ready_for_review' | 'ready_for_submission' | 'ready_to_finalize' | 'review_pending' | 'service_preview' | 'service_requested' | 'sandbox_unsupported' | 'stale_selection' | 'verifying_documents' | 'waiting_on_carrier' | 'waiting_on_documents' | 'waiting_on_payment'
required_upload_typesstring[]
uidstring required

Coverage Cat intake uid for the current handoff.

payment_urlstring uri

Coverage Cat browser URL for secure payment fallback.

known_summaryobject

Structured facts Coverage Cat can safely summarize at this stage.

compare_details_urlstring uri

Coverage Cat browser URL for compare-details follow-up.

uploaded_countinteger
response_summarystring
schemaobject

Supplemental schema hints for homeowners review payloads.

user_action_requiredstring
expires_atstring date-time

When the current consumer handoff expires.

agent_instructionsstring[]
review_tokenstring

Opaque review token for delegated review-style submit paths.

status'abandoned' | 'blocked' | 'bound' | 'cancelled' | 'chosen' | 'credit_consent_pending' | 'credit_consent_required' | 'dev_success' | 'documents_needed' | 'documents_pending_review' | 'email_sent' | 'in_review' | 'ineligible' | 'info_requested' | 'needs_more_info' | 'needs_more_info_to_bind' | 'no_policy' | 'no_chosen_offer' | 'no_quotes' | 'no_selection' | 'ok' | 'payment_collection_ready' | 'payment_needed' | 'pending' | 'pending_quotes' | 'queued' | 'quote_rate_limited' | 'quoted' | 'ready_for_review' | 'ready_for_submission' | 'ready_to_finalize' | 'review_pending' | 'service_preview' | 'service_requested' | 'sandbox_unsupported' | 'stale_selection' | 'verifying_documents' | 'waiting_on_carrier' | 'waiting_on_documents' | 'waiting_on_payment' required
intake_access_tokenstring

Short-lived follow-up bearer. On REST, send it back as Authorization for the next /api/intake/{uid} call. On MCP, retry the same follow-up tool with this token only when your host cannot preserve Coverage Cat's hidden shopper session. Never display it to the shopper.

line'umbrella' | 'homeowners'
offers_urlstring uri

Coverage Cat browser URL for the selected offer or offer-tracking page.

payment_collection_supportedboolean
review_estimatesobject[]
credit_consent_questionstring
next_actionobject

A structured hint for the next allowed tool or endpoint action.

application_submittedboolean
reviewobject

Structured review card or selected-offer review block.

missing_fieldsobject[]

Structured missing-value hints for homeowners pre-submit review.

next_questionobject

The current shopper-owned question bundle or bind-stage question.

sandboxboolean

True when Coverage Cat is returning consumer sandbox test data rather than a live shopper workflow.

selection_guidanceobject

Guidance for completing an offer choice in one shopper-facing reply.

preview_tokenstring

Opaque bind-preview token for the next homeowners bind confirmation.

post_chooseobject

Structured post-choose state after a quoted umbrella offer is selected.

pending_fieldsobject[]

Structured missing-value hints for umbrella pre-submit review.

field_estimatesobject[]

Changes

No recorded changes to this operation across all 1 revision of this API.