Continue the selected-offer bind flow in chat until the offer is chosen and carrier follow-up takes over.

Use this after select returns needs_more_info_to_bind, or when status says ready_to_finalize. Send only the fields from the current bind-stage next_question. When all bind details are present, Coverage Cat will continue the normal choose flow and the agent should keep the user updated by polling status. Successful post-choose responses include offers_url for the secure Coverage Cat offers page, and for Monoline/Markel may also include declarations-upload or payment steps. Sandbox delegated umbrella sessions reject this endpoint with sandbox_unsupported.

post/api/agent/umbrella/bind

Request

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

Minimal patch answering only the fields from the current bind-stage next_question. Do not send quote-affecting changes here.

sandboxboolean

Optional sticky sandbox flag. Sandbox delegated umbrella sessions currently reject bind with sandbox_unsupported; this field is accepted so a client carrying the same request envelope does not fail schema validation first.

uidstring required

Response

Bind continuation state.

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

post_chooseobject
required_upload_typesstring[]
response_summarystring
status'needs_more_info_to_bind' | 'ready_to_finalize' | 'documents_needed' | 'documents_pending_review' | 'payment_needed' | 'chosen'
uidstring

Changes

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