Reinstate Policy Transaction
Reinstates a previously cancelled policy as of a given date via a REINSTATE transaction. The policy must be cancelled at the reinstatement date.
reinstatementDate (= the transaction effective date) is sugar the server expands into
per-segment, segment-scoped deltas. policyStatus flips back to active from the
reinstatement date through end of term, and cancellationEffectiveOnDate is cleared
across the whole term — reinstatement removes the cancellation marker rather than recording
a parallel reinstatement marker. There is no reinstatement date field.
A reinstate may not leave a coverage gap. A reinstate that would leave a cancelled
window between two active periods (e.g. cancel Jun 15, reinstate Jul 1, leaving
Jun 15–Jun 30 cancelled) is rejected with a 400 — the domain models that as a new policy
term, not a reinstatement. A valid reinstate restores continuous coverage and fully clears
the cancellation, so the segments return to their pre-cancellation state (and merge).
A reinstate never reprices — it RESTORES
The server computes what the reinstated term’s pricing contract must be: the pre-cancel
version’s contract, verbatim. Every component comes back — premium, taxes, fees,
commissions — at the value and earningBasis the policy carried before the cancellation, so
the reinstatement is the exact inverse of the cancel’s per-charge floor. Recognition follows:
each charge picks its schedule back up from the reinstatement date, and the earned curve
across cancel-then-reinstate is flat.
“Pre-cancel” is a VERSION, not a date — the version immediately before the CANCEL being undone. Since a reinstatement may not leave a coverage gap, its effective date is the cancellation date, so there is nothing to choose.
A bare { "reinstatementDate": ... } body is the normal request, and it always
succeeds. Omit fullTermPricingInfo and the restored contract is used.
If you DO send fullTermPricingInfo, it is validated against that restored contract
component by component, to the exact cent:
- every component of the pre-cancel contract must be present, at exactly its pre-cancel
value and with its pre-cancel
earningBasis; - an UNRECOGNIZED
<group, label>pair is an addition — money the reinstatement itself creates, typically a reinstatement fee — and it MUST carryearningBasis: "fully-earned-at-inception", because it is recognized on the reinstatement date rather than scheduled over the restored term.
Re-valuing, re-basing or dropping a restored component is rejected with a 400 naming it. To
reprice the restored term, book an endorsement at the same effective date after the
reinstatement: transactions sharing an effective date are applied in booking order (ascending
policyVersion), so reinstate-then-endorse restores the term and then reprices it
prospectively.
Two optional derived channels are whole-object overwrites of a policy-root full-term container — necessarily whole-term, so neither carries dates nor an element-level form:
fullTermPricingInfo— the full-term pricing contract, validated as described above.fullTermPolicyRatingResult— the canonical policy-level rating result. Unvalidated and unconstrained: it is the rater’s own output, not the money the platform books.
Policy invoices. Optionally send invoicePlan, a fully explicit
keep/void/create plan. Nothing is defaulted or inferred. If reinstatement
moves a billed policy’s pricing target, a conserving plan is required.
Required permission: policy:update
Authorizations
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
Company identifier
Policy identifier
Body
The date the reinstatement takes effect in ISO 8601 format. Must fall within the policy term, and the policy must be cancelled at this date.
When the business decision was made. Defaults to the current time if omitted. Set explicitly for imports (e.g., aligning to a bordereau booking date).
OPTIONAL — omit it and the server restores the pre-cancel contract (recommended).
When supplied, it must be that restored contract plus additions: every component
of the pre-cancel version, present at exactly its pre-cancel value and
earningBasis, plus any NEW <group, label> pairs (reinstatement fees) carrying
earningBasis: "fully-earned-at-inception". Each component is
{label, group, kind, value[, earningBasis]}; the five rollups are computed by
the platform and any you send are ignored. Compared to the exact cent — there is
no tolerance.
Optional whole-object overwrite of the policy-root canonical rating result.
A fully explicit, detached policy-invoice batch. Existing invoices not named in voidInvoices are kept. The complete kept-plus-created set must conserve every bound component of the policy's current pricing contract.
Response
Policy reinstated successfully
Response returned by policy transaction endpoints. Contains the policy version produced by the transaction, including all derived segments.
Policy identifier
Sequential version number produced by this transaction
Identifier of the transaction that produced this version
Policy term start date (ISO 8601)
Policy term end date (ISO 8601)
When the transaction was created (ISO 8601)
Derived segments for this policy version. Each segment represents a maximal contiguous date range where policy state is identical. Adjacent segments with identical data are automatically merged.
Plain-text primary-insured name, read from the policy's own
primaryInsuredName field — the source of truth for the primary insured.
Reported as of the END of
the term, so a policy whose insured changed mid-term returns the later name;
segments[] carries the per-segment history. Null only when the version
carries no policy data.
Id of the entity behind primaryInsuredName. Null when the policy's
configuration does not populate it.
The policy number, read from the policy's own policyNumber field — the
source of truth, invariant across the whole term. Null only when the version
carries no policy data.
Policy term start date as the structured date object, read from the policy's
own policyStartDate field — the source of truth, invariant across the whole
term. This is not startDate above: that is the ISO
span this version covers, which a cancellation makes shorter than the term.
Null only when the version carries no policy data.
Policy term end date as the structured date object, read from the policy's own
policyEndDate field — the source of truth, invariant across the whole term.
This is not endDate above: that is the ISO
span this version covers. Null only when the version carries no policy data.
The policy's full-term pricing contract, hoisted as a read-once convenience
(also duplicated in every segment): pricingComponents (each
{label, group, kind, value[, earningBasis]}) plus the five server-computed,
read-only rollups (premium, taxes, fees, brokerCommission,
programCommission — each the sum of its kind's components).
Derived canonical policy-level rating result for the full term, hoisted as a
read-once convenience (also duplicated in every segment). Element-level rating
output (crossSegmentRatingOutputs) stays inline at its host and is not hoisted.