Get Policy Version
Returns a specific version of a policy with all its derived segments.
Each segment contains the full policy state (policy-level fields and nested exposures)
for a contiguous date range. The whole-term policy facts (policyNumber,
policyStartDate, policyEndDate) and the fullTermPricingInfo /
fullTermPolicyRatingResult containers are hoisted from the segments for convenience —
these are full-term invariant, identical across all segments in a version. Segment-scoped
policyStatus is not among them; it lives on each segment’s policy.
Required permission: company.policy:read
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
Policy version number (sequential, starting at 1)
x >= 1Response
Policy version with segments
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.
