Skip to main content
POST

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

Body

application/json
policyId
string<uuid>
required

The source policy to convert from.

Example:

"550e8400-e29b-41d4-a716-446655440000"

effectiveDate
string<date>
required

The transaction's effective date. Selects which segment of the source policy is read (see the table above) and is readable by a Conversion Rule as transaction.effectiveDate.

Example:

"2026-06-01"

transactionType
enum<string>
required

Which transaction the generated quote would start. NEW_BUSINESS is not accepted here — it has no source policy to convert from.

Available options:
ENDORSE,
CANCEL,
REINSTATE,
RENEW
Example:

"ENDORSE"

endDate
string<date>

An endorsement's optional term end date, readable by a Conversion Rule as transaction.endDate. null in that scope for every other transaction type.

Example:

"2026-12-31"

Response

The editable, unpersisted Quote data with its provenance. Returned whether or not validationIssues is empty — a non-empty list still carries a usable draft. Nothing was persisted.

data
object
required

The finished Quote draft, in the same flat shape you would POST to bind: every declared Quote field, with quoteType set from transactionType, calculated fields worked out, and null where nothing fills a field or a value needs a saved quote. Edit it and send it on; it exists nowhere on the server.

sourcePolicy
object
required
effectiveWindow
object
required

The coverage window of the source segment that was read.

validationIssues
object[]
required

What the draft's own checks find in data, such as a field you must supply or a value that fails its field's type check. Empty means nothing is left to fix for a bind by value. A draft you save as a quote also needs referencingPolicy and its change date, which this list does not report.