PolicyReferenceGenerationRequest

object

Request payload for generating a policy reference. Supply the insured, producer, product, and underwriter at minimum — all as id references.

insuredobjectrequired

Insured contact — id only.

* Additional properties are NOT allowed.
Show Child Parameters
producerobjectrequired

Producer (broker) — id only.

* Additional properties are NOT allowed.
Show Child Parameters
mopobjectrequired

MOP (Method of Placement) code only.

* Additional properties are NOT allowed.
Show Child Parameters
notesstring

Optional free-text notes for the policy reference.

policyyearnumberstringrequired

Policy year number.

Example:26

policyyearstring

Policy year.

Example:26

productobjectrequired

Product reference id only.

* Additional properties are NOT allowed.
Show Child Parameters
quoteobject

Quote type code only (e.g. Q).

* Additional properties are NOT allowed.
Show Child Parameters
underwriterobjectrequired

Underwriter reference id only.

* Additional properties are NOT allowed.
Show Child Parameters
Example

PolicyReferenceResponse

object

Response returned after generating a policy reference. Contains the generated reference, associated keys, and input echo fields.

createdByinteger(int32)

Contact key of the user who created the reference.

Example:2000574

generatedReferencestring

The generated policy reference string.

Example:PCY2434926AA

insuredstring

Insured contact id echoed from the request.

Example:3000211

policyreferencekeyinteger(int32)

Internal policy reference key identifier.

Example:646

notesstring

Notes echoed from the request.

policyYearstring

Policy year echoed from the request.

Example:26

policyYearNumberinteger(int32)

Policy year number echoed from the request.

Example:26

producerstring

Producer contact id echoed from the request.

Example:2000987

productinteger(int32)

Product identifier.

Example:4

underwriterinteger(int32)

Underwriter contact key.

Example:2000310

Example

PolicyStatusSummary

object

Summary of a policy returned by the /policies/status endpoint.

policykeyinteger

Internal policy key identifier

Example:1086334

policyactivitykeyinteger

Internal policy key identifier

Example:1141169

accountinteger

Account contact key

Example:4040940

insuredinteger

Insured contact key

Example:4040940

producerinteger

Producer contact key

Example:2000556

productinteger

Product identifier

Example:4

effectiveDatestring(date)

Policy effective date

Example:2026-01-15

expiryDatestring(date)

Policy expiry date

Example:2027-01-15

idinteger

Identifier

policyStatusstring

Current status of the policy

Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU

Example:Bound

policyActivityStatusstring

Status of the policy

Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU

Example:Bound

Example

ContactFuzzySearchItem

object

A 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.

* Additional properties are allowed.

FullRequest

object

Combines 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.

underWriterobjectrequired

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.

* Additional properties are NOT allowed.
Show Child Parameters
mosaicOccupationobjectrequired

Required. Mosaic occupation — id only. Required for all LOBs. Source: insured occupation lookup.

* Additional properties are NOT allowed.
Show Child Parameters
producingCompanyobject

Conditional. Producing company — id only. Required when division is Mosaic Asta Europe (MAE).

* Additional properties are NOT allowed.
Show Child Parameters
lloydsIndustrialSectorobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
revTurnoverinteger(int32)required

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

insuredobjectrequired

Required. Insured details — use insureContacts.id for an existing contact, or supply companyName + domicile fields for a new insured.

Show Child Parameters
producerobjectrequired

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
policyobjectrequired

Required. Policy node (dates, currency, product, territory).

Show Child Parameters
directAssumedobjectrequired

Required. Business type — id only (Direct or Assumed).

* Additional properties are NOT allowed.
Show Child Parameters
typeOfBillingobjectrequired

Required. id only.

* Additional properties are NOT allowed.
Show Child Parameters
divisionobjectrequired

Required. id only.

* Additional properties are NOT allowed.
Show Child Parameters
writtenLineinteger(int32)required

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

policyDescriptionstring

Optional. Free-text policy description. Defaulted/derived server-side when omitted.

Example:Cyber primary 2026 renewal

sectionIdentifierobjectrequired

Required. Section identifier — id only (1 = C&C, 2 = Non C&C).

* Additional properties are NOT allowed.
Show Child Parameters
referenceTypeobjectrequired

Required. Reference type — id only (1 = EEA, 2 = Non-EEA, 3 = Both).

* Additional properties are NOT allowed.
Show Child Parameters
classobject

Optional. Risk class — code only (e.g. { "code": "CY" }).

* Additional properties are NOT allowed.
Show Child Parameters
typeOfPlacementBespokeobjectrequired

Required. Mosaic MOP / bespoke type of placement — id only.

* Additional properties are NOT allowed.
Show Child Parameters
producingUnderwriterobject

Optional. Producing underwriter — id only. The underwriter who produced this submission.

* Additional properties are NOT allowed.
Show Child Parameters
marketSourceobject

Optional. Market source — id only.

* Additional properties are NOT allowed.
Show Child Parameters
Example