Create or update a delegated umbrella session, continue hidden enrichment, and return the single review page when ready.

Use this endpoint as the primary operator-side enrichment loop. Search allowed context sources first and send the fullest application you can, including field_estimates metadata for inferred values. If status is needs_more_info, keep working behind the scenes with pending_fields, suggested_values, and next_question; do not turn that state into a user questionnaire unless your product intentionally falls back to one. If you exhaust approved context and still cannot reach ready_for_review, stop and escalate rather than silently presenting a partial review page. If status is ready_for_review, render the formatted review JSON with field_estimates paths marked with *, include the short note * = estimated once above and once below the review list, and do not prefix every estimated line with [Estimated]. Preliminary umbrella quotes do not require credit consent; Coverage Cat collects the soft-credit pull authorization at select. Set sandbox: true only on the first create call when you want mocked delegated umbrella test data instead of live customer email or carrier traffic.

post/api/agent/umbrella/draft

Request

  • Base URL: https://api.coveragecat.com
  • URL: https://api.coveragecat.com/api/agent/umbrella/draft
  • 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

intakeobject

Partial umbrella intake patch. Prefer sending the fullest context-backed application you can assemble from CRM, email threads, document drives, OCR'd policy files, and prior Coverage Cat sessions. Send only changed fields on follow-up calls instead of resubmitting the full application. Accepted aliases: birthday -> age, spouse_birthday -> spouse_age, approximate_asset_value -> net_worth_numeric. Send birthdays to Coverage Cat as ISO dates; if the shopper replies in normal US MM-DD-YYYY form, normalize it to ISO before sending. Do not send raw integer ages. Common keys include full_name, email, phone_number, age, marital_status, license_status, license_state, license_number, address, occupation, line_of_work, net_worth_numeric, additional_drivers, household_members, auto_has_insurance, coverage_e_for_residences, has_citizens_home_coverage, and umbrella_details.

sandboxboolean

Optional mocked-mode flag for delegated umbrella testing. Set this to true only when creating a brand-new delegated umbrella session. The sandbox flag sticks to that uid, reuses the real draft/review validation loop, returns mocked quote responses, and does not send live customer emails or carrier traffic.

uidstring

Existing delegated umbrella session identifier. Omit to create a new one.

Response

Current delegated umbrella state.

agent_instructionsstring[]
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.

response_summarystring
reviewobject

Full review JSON to render only when status is ready_for_review. Render it directly, mark every field_estimates[].review_path entry with *, include the short note * = estimated once above and once below the review list, and do not prefix every estimated line with [Estimated]. Credit consent is not asked here; Coverage Cat collects it at select.

review_tokenstring

Token bound to the latest review JSON. Refresh it after every draft edit before calling quotes.

sandboxboolean

True when this delegated umbrella session is running in mocked sandbox mode.

status'needs_more_info' | 'ready_for_review' | 'ineligible'
suggested_valuesobject

Historical-mode fallback priors for unresolved fields. Treat these as hints for operator-side enrichment, not as substitutes for actual user or document-backed answers.

uidstring

Changes

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