Poll the delegated umbrella session so the user can stay in chat.

Returns the current chat-manageable state for the delegated umbrella session, including quote selection, bind-stage follow-up questions, declarations-upload, declarations-review, payment, waiting-on-carrier, info-requested, blocked, and bound states. Chosen and waiting responses may include offers_url so the user can review the selected offer on Coverage Cat without leaving the normal workflow. If the session is back at ready_for_review, render the same single review page described on the draft endpoint. When documents_pending_review includes poll_after_seconds, wait that long before polling again unless the user asks for an update sooner. PaymentTransition: follow chosen -> documents_needed -> documents_pending_review -> payment_needed -> waiting_on_carrier -> bound. For Monoline and Markel, documents_pending_review means Coverage Cat has the declarations upload on file and is processing the chosen offer; payment_needed usually appears within about 5-10 minutes and includes a secure payment_url. Sandbox delegated umbrella sessions use this endpoint to rehearse the mocked draft/review/quote loop after offers are returned.

PaymentTransition: follow chosen -> documents_needed -> documents_pending_review -> payment_needed -> waiting_on_carrier -> bound. For Monoline and Markel, documents_pending_review means Coverage Cat has the declarations upload on file and is processing the chosen offer with the insurer; payment_needed usually appears within about 5-10 minutes and means the current checkout price shown came directly from the insurer while Coverage Cat is down to final declarations verification before charging the card, alongside a secure payment_url.

post/api/agent/umbrella/status

Request

  • Base URL: https://api.coveragecat.com
  • URL: https://api.coveragecat.com/api/agent/umbrella/status
  • Auth: HTTP bearer

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

sandboxboolean

Optional mocked-mode flag. Once a delegated umbrella session is created with sandbox: true, later status calls may omit it because the uid stays sandbox-scoped.

uidstring required

Response

Current delegated umbrella status.

agent_instructionsstring[]
compare_details_urlstring uri
credit_consent_questionstring

Present when Coverage Cat needs the real user's consent for a soft credit check before binding an offer, typically returned from select with status: credit_consent_required.

known_summaryobject

Current delegated umbrella application summary. This may include PII such as applicant name, email, phone number, and address; do not treat it as safe-to-log telemetry.

offers_urlstring uri

Secure link to the Coverage Cat offers page for this delegated session.

payment_urlstring uri

Secure payment-setup link, returned only when Coverage Cat is ready to collect payment.

policyobject
poll_after_secondsinteger
post_chooseobject
required_upload_typesstring[]
response_summarystring
reviewobject

Review JSON for the latest ready-for-review state.

review_tokenstring
sandboxboolean

True when this delegated umbrella status payload is mocked sandbox data.

selection_guidanceobject
status'ineligible' | 'needs_more_info' | 'ready_for_review' | 'quoted' | 'no_quotes' | 'needs_more_info_to_bind' | 'ready_to_finalize' | 'documents_needed' | 'documents_pending_review' | 'payment_needed' | 'waiting_on_carrier' | 'info_requested' | 'bound' | 'blocked'
uidstring

Changes

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