Skip to main content
GET
Check Bind Conditions

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

quoteId
string<uuid>
required

Quote identifier

Query Parameters

invoices
enum<string>

The invoices the bind will state, which the check mirrors. generate checks the plan the bind would generate from the quote's invoice settings; saved checks the plan saved on the quote; omitted checks a bind of no invoices. Nothing is persisted.

Available options:
generate,
saved

Response

The bind-condition check result for the quote.

readyToBind
boolean
required

True only when failures is empty.

failures
object[]
required

Every unmet bind condition, one entry per message. A rule the check could not evaluate appears here too, with a message naming it.

advisories
object[]
required

One entry per rating workflow whose rating is out of date; empty when none is. Never changes readyToBind.

checkScope
enum<string>

Present for same-term quote flows whose check covers financial readiness rather than full-policy conversion.

Available options:
endorsement-billing,
cancellation-billing,
reinstatement-billing