Create a consumer-prefill homeowners handoff.

Accepts the fullest consumer homeowners application you can assemble, prepares Coverage Cat's one-shot review and soft-credit consent checkpoint, and returns the handoff uid, a rotating intake_access_token for direct API follow-up, a short-lived /intake?resume=... browser fallback URL, and a coarse public polling_token. On a cold start, ask only for the shopper's full name, email, property address, and whether the property should be treated as standard homeowners, condo, or landlord coverage first. The initial intake.home[0] data must preserve that distinction by sending home_ownership: owned_rental or a rented rental_status for landlord coverage, property_type: condo for condo coverage, or both a non-rental home_ownership and a non-condo property_type for standard homeowners coverage. Then recover core shopper and occupancy facts such as date of birth, marital status, and owner-occupied vs new-purchase from user-controlled context before calling this endpoint. Until a later follow-up response shows quote progress, the application is not submitted yet. Coverage Cat can then estimate many reviewable home fields for the review card. Stay on the same consumer follow-up loop through long-lag quote polling, /api/intake/{uid}/select, /api/intake/{uid}/bind, and later /api/intake/{uid}/policy plus /api/intake/{uid}/service; do not switch to delegated operator endpoints just to keep the shopper moving. Homeowners quotes or carrier bind follow-up may take up to 48 hours, so keep polling and keep the registered customer email channel on file. Coverage Cat does not collect first-party homeowners payment in chat; any carrier payment or signing link goes directly to the customer's email on file. On the review turn, tell the shopper explicitly that Coverage Cat has not submitted the application yet, ask for any remaining items or the soft-credit Yes/No in plain English, and render 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]. Successful direct follow-up responses rotate a fresh intake_access_token; always reuse the newest token you have.

post/api/consumer/homeowners/prefill

Request

  • Base URL: https://api.coveragecat.com
  • URL: https://api.coveragecat.com/api/consumer/homeowners/prefill
  • Auth: none required

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

credit_consent_pendingtrue required

Must be true. Signals that the user has not yet been shown the review page. Homeowners handoffs collect consent for a soft credit check on that review turn; umbrella handoffs defer credit consent until the user chooses an offer at select.

field_estimatesobject[]

Optional estimate metadata for values that are defensible but not yet directly confirmed by the user. On the initial consumer umbrella handoff, prefer sending only intake; add top-level field_estimates only when you are certain each field already matches a current umbrella review field path.

Response

Consumer homeowners handoff prepared.

expires_atstring date-time required

When the returned consumer handoff credentials expire.

intake_access_tokenstring required

Short-lived direct follow-up bearer for /api/intake/{uid}.

polling_tokenstring required

Opaque coarse-status polling token for /api/consumer/status.

resume_urlstring uri required

Short-lived browser continuation for the same consumer handoff.

sandboxboolean

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

uidstring required

Coverage Cat intake uid for follow-up.

Changes

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