Policy
Create, retrieve, and search policies across the lifecycle.
Issue Policy (Asynchronous)
Runs the complete Mosaic submission pipeline (Shell → Full → Quote → Bind) in a single request, orchestrated by an internal state machine.
You send one payload — the platform handles all lifecycle stages internally. There is no need to make separate calls for shell, full, quote, or bind.
The shell step runs synchronously and returns policyNo, policyKey, and policyActivityKey in the response. The full, quote, and bind steps continue asynchronously — poll GET /policies/orchestrate/{policyNo}/stepStatus to track progress.
Payload structure
| Block | Purpose | Required? |
|---|---|---|
fullRequest |
Shell (account / policy / producer) + Full (underwriting) data | Yes |
quoteRequest |
Pricing, sections, coverages, lines (includes bind-time & FON attributes per section/line) | Recommended |
bindRequest |
Policy-level bind data (insured enrichment, sanction check, surplus broker, FON activity) | Recommended |
Response timing
The shell step runs synchronously and is expected to respond within two minutes or less, subject to XFI availability and performance. It returns policyNo, policyKey, and policyActivityKey in the response. The full, quote, and bind steps continue asynchronously. Poll GET /policies/orchestrate/{policyNo}/stepStatus to track progress.
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Body
application/json
Body
Container carrying the submission bodies for the TridentGlobalSubmission state machine: fullRequest (required; includes shell+full data), quoteRequest (quote + merged section-level bind attributes, optional), and bindRequest (policy-level bind, no sections, optional). Each object is forwarded verbatim to its matching step — use the same JSON the standalone endpoints accept.
IssuePolicyRequest
Single-call submission payload. Combines Shell + Full + Quote + Bind data so external consumers send everything once — the platform executes each stage internally in sequence.
fullRequest is required and carries the insured/policy/producer identifiers (shell) plus underwriting enrichment (full). quoteRequest carries all pricing, section, and line data, including bind-time attributes for each section and line. bindRequest carries the policy-level bind attributes that are not tied to a specific section or line.
Required. Shell (Step 1) and Full (Step 2) data combined.
Required fields: underWriter (id), revTurnover.
Required shell fields (first submission): insured, producer, policy (effectiveDate, expiryDate, currency, product, territory), directAssumed, typeOfBilling, division, writtenLine, sectionIdentifier, referenceType, typeOfPlacementBespoke.
Optional fields: producingUnderwriter (id), producingCompany (id), lloydsIndustrialSector (id).
Per-line fields (ourRole, signedLinePercentage) belong in quoteRequest.lines[].
Show Child Parameters
Quote, FON, and bind attributes at the section and line level.
Required quote fields: sections (array, at least one), summaryCurrency (code), typeOfCyberClauseStatus (id), uSClassification (id).
Each entry in sections[] carries coverage lines, deductions, deductibles, reinstatements, regulatory coding, and bind-time attributes (instalmentbasis, paymentDays, premiumBasis, typeofClaimBasis).
Each entry in lines[] represents an agency line and carries submission fields (underWriter, typeOfBilling, division, writtenLine, producingCompany, sBFClass), quote fields (ourRole, signedLinePercentage, producingUnderwriter, lloydsPlatform, bureauLead, isThirdPartyCapacityDeployed), FON fields (brokerOrderPercent, signedOrderPercent, policyLineReference), and bind fields (claimsAgreementParty, defenseCostsCovered, leaderPercent, leaderReference, actualDateWritten, dateSigned, policyLineReferenceOverride). Syndicate lines and derived fields (originating division/office, global-risk cross-reference, inclusive line) are handled by Trident.
Show Child Parameters
Policy-level bind attributes —
Key required fields: prebindSanctionCheckComplete.
Supply insured for bind-time enrichment (occupation, mailing address, TINs). Supply surplusBroker when risk premium originates from the United States. Supply fon for FON activity attributes (CY LOB only).
claimsAgreementParty is a per-line attribute — supply it on each entry in quoteRequest.lines[], not here.
Section/line attributes (premiumBasis, typeofClaimBasis, instalmentbasis, leaderPercent, etc.) are carried in quoteRequest — not repeated here.
Show Child Parameters
Response
application/json
Response
Base step succeeded; the full step is running asynchronously.
GlobalSubmissionResponse
Minimal response returned after the base Step Function completes.
Correlation id for tracing the background full + quote executions in logs
Example:9b3f7c1c-1f0a-4e2d-9d7c-2e3a8b4c6d2e
Policy number produced by the base submission step
Example:Q0038456
Policy key produced by the base submission step, propagated to the async steps
Example:20894
Policy activity key produced by the base submission step
Example:45632
ACCEPTED means the full step is running in background; FAILED means the base step failed
Allowed values:ACCEPTEDFAILED
Example:ACCEPTED
Human-readable message
Example:Base submission succeeded. The full step is running asynchronously.
Authentication
Headers
Body
Generate Policy Reference (Synchronous)
Generates a policy reference number by forwarding the request to the outbound-services-call API. Returns the generated policy reference along with policy keys and status.
Required fields
insured, producer, product, underwriter.
Optional fields
mop, notes, policyyearnumber, policyyear, quote.
Lookup objects
insured, producer, product, and underwriter accept id only. mop and quote accept code only.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Body
application/json
Body
Policy reference generation payload.
PolicyReferenceGenerationRequest
Request payload for generating a policy reference. Supply the insured, producer, product, and underwriter at minimum — all as id references.
Insured contact — id only.
Show Child Parameters
Producer (broker) — id only.
Show Child Parameters
MOP (Method of Placement) code only.
Show Child Parameters
Optional free-text notes for the policy reference.
Example:[ "" ]
Policy year number.
Example:26
Policy year.
Example:26
Product reference id only.
Show Child Parameters
Quote type code only (e.g. Q).
Show Child Parameters
Underwriter reference id only.
Show Child Parameters
Response
application/json
Response
Policy reference generated successfully.
PolicyReferenceResponse
Response returned after generating a policy reference. Contains the generated reference, associated keys, and input echo fields.
Contact key of the user who created the reference.
Example:2000574
The generated policy reference string.
Example:PCY2434926AA
Insured contact id echoed from the request.
Example:3000211
Internal policy reference key identifier.
Example:646
Notes echoed from the request.
Example:[ "" ]
Policy year echoed from the request.
Example:26
Policy year number echoed from the request.
Example:26
Producer contact id echoed from the request.
Example:2000987
Product identifier.
Example:4
Underwriter contact key.
Example:2000310
Authentication
Headers
Body
Get Policy Status (Synchronous)
Retrieves policy details including status, key identifiers, and metadata for a given policy key.
Monitoring policy progression
Poll this endpoint and inspect policyStatus and policyActivityStatus until the policy reaches the desired Quote In Preparation, Quote, or Bound state, or an errorMessage block appears. XFI may report Quote In Preparation as Quote Preparation. When errorMessage is present, the transaction could not progress to the desired state; treat the error as the outcome even if a target status is also shown, and use its details to determine the next steps. An HTTP 200 response means the status was retrieved, not necessarily that the transaction succeeded.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
Policy key (mandatory)
Example:22170
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Response
application/json
Response
Policy status retrieved successfully
PolicyStatusSummary
Summary of a policy returned by the /policies/status endpoint.
Internal policy key identifier
Example:1086334
Internal policy key identifier
Example:1141169
Account contact key
Example:4040940
Insured contact key
Example:4040940
Producer contact key
Example:2000556
Product identifier
Example:4
Policy effective date
Example:2026-01-15
Policy expiry date
Example:2027-01-15
Identifier
Example:0
Current status of the policy
Example:Bound
Status of the policy
Example:Bound
Present when an XFI error prevents the policy from progressing to its desired state. Use these details to determine the next steps.
Show Child Parameters
Authentication
Query Parameters
Headers
Promote Policy to Live (Synchronous)
Fetches live policy details for the given policyKey and policyActivityKey.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
Policy key
Example:1087638
Policy activity key
Example:1142564
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Response
application/json
Response
Live policy details fetched successfully
LivePolicyResponse
Example:Live Policy
Example:Q1100077
Example:F0025667
Example:1087748
Example:1142676
Example:Issued