PolicyReferenceGenerationRequest
objectRequest 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.
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
PolicyReferenceResponse
objectResponse 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.
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
PolicyStatusSummary
objectSummary 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
Current status of the policy
Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU
Example:Bound
Status of the policy
Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU
Example:Bound
ContactFuzzySearchItem
objectA single contact entry returned by the /lookup/contacts endpoint, passed through from XFI’s summary object verbatim. Backing Java type is Map<String, Object> — keys are not fixed/known in advance (XFI may return any of contactKey, contactReference, code, roleCode, mainrole, email, mailingAddress1, mailingAddress2, mailingAddressCity, country, or others), so no fixed property list is declared here.
FullRequest
objectCombines Shell (Step 1) and Full (Step 2) submission data.
Required: underWriter (id), revTurnover.
Shell fields (insured, producer, policy, directAssumed, typeOfBilling, division, writtenLine, sectionIdentifier, referenceType, typeOfPlacementBespoke, class) are required on first submission and optional on subsequent re-submissions (already on the draft).
Optional fields: producingUnderwriter (id), producingCompany (id), lloydsIndustrialSector (id), marketSource (id).
Per-line fields (ourRole, signedLinePercentage) are set via lines[] in quoteRequest.
Required. Underwriter who submitted the risk request — id only. Must be the underwriter with authority to write the business. Source: underwriter’s email or document.
Show Child Parameters
Required. Mosaic occupation — id only. Required for all LOBs. Source: insured occupation lookup.
Show Child Parameters
Conditional. Producing company — id only. Required when division is Mosaic Asta Europe (MAE).
Show Child Parameters
Conditional. Lloyd’s Industrial Sector override — id only. Required for all LOBs. When supplied, takes precedence over the server’s automatic derivation (UC8). Leave blank to allow automatic derivation.
Show Child Parameters
Required. Insured’s annual revenue or turnover (numeric). Required for CY, FI, PL and Casualty LOBs. Source: booking sheet or Tyche rater. Update if a more accurate figure is available at quote stage.
>= 0
Required. Insured details — use insureContacts.id for an existing contact, or supply companyName + domicile fields for a new insured.
Show Child Parameters
Required. Producer (broker) reference. Supply id (producer id only). Optionally include a contactliaison block to attach, create, or update the broker contact liaison recorded on the policy (see ContactLiaisonSubmission).
Show Child Parameters
Required. Policy node (dates, currency, product, territory).
Show Child Parameters
Required. Business type — id only (Direct or Assumed).
Show Child Parameters
Required. id only.
Show Child Parameters
Required. id only.
Show Child Parameters
Written line percentage (numeric, e.g. 100). Default to 100 if not specified by the underwriter. If provided, enter the value from the underwriter’s email or document. For Agency Share %, enter the agency percentage here. Can be updated at any stage.
>= 1
Example:100
Optional. Free-text policy description. Defaulted/derived server-side when omitted.
Example:Cyber primary 2026 renewal
Required. Section identifier — id only (1 = C&C, 2 = Non C&C).
Show Child Parameters
Required. Reference type — id only (1 = EEA, 2 = Non-EEA, 3 = Both).
Show Child Parameters
Optional. Risk class — code only (e.g. { "code": "CY" }).
Show Child Parameters
Required. Mosaic MOP / bespoke type of placement — id only.
Show Child Parameters
Optional. Producing underwriter — id only. The underwriter who produced this submission.
Show Child Parameters
Optional. Market source — id only.