New Business Transaction
Creates a new policy via a NEW_BUSINESS transaction. This is the entry point for the transaction-based policy lifecycle. The transaction produces a single segment covering the full policy term.
The request body is the complete initial policy state in fieldModelV1Data — policy-level
fields and the full-term containers. The only platform-required exposure linkage is the
primary-insured identity on fullTermPolicyInfo: primaryInsuredJoin (the id of an
existing Exposure record) plus primaryInsuredName. Any embedded exposure fields your
company configuration defines (e.g. primaryInsured / additionalExposures in the default
configuration) ride along as ordinary configured fields, validated per-field against the
Exposure configuration.
Term bounds come solely from fullTermPolicyInfo. policyStartDate and policyEndDate
are read from fieldModelV1Data.policy.fullTermPolicyInfo — there are no top-level date
parameters. The transaction’s effective date is the policy start date.
Required permission: company.policy:create
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
Body
Container for policy state. Must contain a policy object with all policy-level
fields.
Custom fields within the policy — including the values of any embedded exposure fields — are validated against your company's field configuration. Unknown fields are rejected, required fields must be present, and values must match their configured types (including option set membership). Embedded entity values are validated per-field against the embedded entity's own configuration.
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).
Response
Policy created 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.
Endorsable full-term policy info, hoisted as a read-once convenience (also
duplicated in every segment). Contains term dates, the renewal pointer
(previousPolicyId), and the primary insured reference. Term bounds are
sourced here. Segment-scoped policyStatus is not part of this object.
Derived full-term billing aggregates, hoisted as a read-once convenience (also duplicated in every segment). Contains premium, taxes, fees, and grand total for the full policy term.
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.
