Search
K
UAT APIs

SubmissionProducer

object

Producer (broker) reference used on a submission. id identifies the producer (broker company). Optionally include a contactliaison block to attach, create, or update the broker contact liaison recorded on the policy.

idstringrequired

Required. XFI contact key of the producer (broker company). id only.

Example:2000556

contactliaisonobject

Optional. Broker contact liaison to record on the policy. See ContactLiaisonSubmission for the attach/create/update behavior.

Example:{"firstName":"John","lastName":"Smith","email":"Yes@example.com","phoneNo":"9000000000","mobilePhone":"899 898 09","faxNo":"45","state":{"code":"UT"},"city":{"description":"Green Bay"},"region":{"description":"GBR"},"contactliaisonid":{"id":"1234"}}

Show Child Parameters
Example

ContactLiaisonSubmission

object

Broker contact liaison recorded under the producer for this submission. The platform resolves this block one of three ways:

  1. Update by key — supply contactliaisonid.id (an existing liaison key). That liaison is updated in place with the email, phoneNo, and mobilePhone values provided; the platform targets it directly without searching by name. firstName + lastName must also be supplied.
  2. Update by name match — omit contactliaisonid. When firstName + lastName match an existing liaison under the producer, that liaison is updated in place.
  3. Create — omit contactliaisonid and supply a firstName + lastName that do not match any existing liaison; a new liaison is created.

firstName and lastName are required in all three cases.

contactliaisonidobject

Optional. Existing contact liaison key (id only). When supplied, the platform attaches that liaison and all individual fields become optional. Omit to create or update by name match.

* Additional properties are NOT allowed.
Show Child Parameters
firstNamestringrequired

Required when creating a new contact (Mode B). First name of the broker contact person.

Example:John

lastNamestringrequired

Required when creating a new contact (Mode B). Last name of the broker contact person.

Example:Smith

emailstring(email)

Required when creating a new contact (Mode B). Email address of the liaison.

Example:Yes@example.com

phoneNostring

Required when creating a new contact (Mode B). Office/landline phone number of the liaison.

Example:9000000000

mobilePhonestring

Optional. Mobile / cell phone number of the liaison.

Example:899 898 09

faxNostring

Optional. Fax number of the liaison.

Example:45

stateobject

Optional. State where the liaison is located. Always send as code, e.g. { “code”: “UT” }.

Example:{"code":"UT"}

Show Child Parameters
cityobject

Optional. City where the liaison is located. Always send as description, e.g. { “description”: “Green Bay” }.

Example:{"description":"Green Bay"}

Show Child Parameters
regionobject

Optional. Region of the liaison. Always send as description, e.g. { “description”: “GBR” }.

Example:{"description":"GBR"}

Show Child Parameters
Example

ShellSubmissionResponse

object
policyStatusstring
policyNostring
referencestring
policyKeystring
policyActivityKeystring
policyActivityStatusstring
Example

IssuePolicyRequest

object

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.

fullRequestobjectrequired

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
quoteRequestobject

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
bindRequestobject

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
Example

BindRequest

object

Policy-level bind attributes. Supply everything that does not belong to a specific section or line.

Key required fields: prebindSanctionCheckComplete.

claimsAgreementParty is a per-line attribute — supply it on each entry in quoteRequest.lines[], not here (XFI only exposes it at the policy-line level).

Section/line attributes (premiumBasis, typeofClaimBasis, instalmentbasis, leaderPercent, etc.) are carried in quoteRequest — not repeated here.

The optional fon block carries FON-stage policy-activity attributes (CY LOB only). The optional surplusBroker block is required for US-origin risks.

prebindSanctionCheckCompletebooleanrequired

Required. Confirms the pre-bind sanction check has been completed. Set to true before proceeding to bind. The submission will be rejected if this check has not been completed.

Example:true

obligorobject

Obligor contact reference — id only.

* Additional properties are NOT allowed.
Show Child Parameters
majorPerilobject

Major peril classification — id only. Server-derived from the risk’s class; supply here to override the derivation.

* Additional properties are NOT allowed.
Show Child Parameters
territoryobject

Territory of the risk — code only (e.g. { "code": "USA" }). Represents the location of the risk, not the regulatory location. When multiple locations exist, use the country with the highest concentration of risk properties. Raise a query to the underwriter if the territory is unclear.

* Additional properties are NOT allowed.
Show Child Parameters
typeofRIBasisobject

Type of RI basis — id only. Required for Assumed (RI) business. Leave blank for Direct business.

* Additional properties are NOT allowed.
Show Child Parameters
priorPendingstring(date)

Prior and pending date (ISO 8601 date string, e.g. ‘2025-01-01’). Required for CY LOB. Leave blank for all other LOBs.

Example:2026-01-01

priorActsboolean

Whether prior acts cover applies to this risk.

Example:true

retroactiveDatestring(date)

Retroactive date (ISO 8601 date string). Only applicable when priorActs is true; leave blank when priorActs is false. Required for PV, CY and PL LOBs. Leave blank for all other LOBs.

Example:2026-01-01

insuredobject

Bind-time insured enrichment — occupation, mailing/issuance address, policyholder type, and TINs.

Required fields: occupationSource (id), occupation, mailingAddressCountry (code).

Conditional required: mailingAddressState (US/Canada); webSite (CY LOB); assetsUnderManagement + assetSize (FI LOB); taxIdSpain / taxIdPortugal / taxIdItaly / canadianBusinessNumber (where insured has exposure in those countries).

Show Child Parameters
surplusBrokerobject

Surplus lines and sub-producer details. Required when risk premium originates from the United States.

Required fields: typeOfAdmitted (id, set to Surplus), surplusLinesBroker (id), brokerLicense, producerHomeState (code).

Additionally required when producerHomeState is New Jersey: slaNumber.

Show Child Parameters
tailEffectiveDatestring(date)

Tail effective date at policy-activity level (ISO 8601 date string). Leave blank unless a tail period applies to this risk.

Example:2026-01-01

fonobject

FON (Final Offer & Negotiation) policy-activity attributes. CY LOB only.

Required FON fields: fonDate (date), jurisdictionCountry (code), riskRegulatoryLocation (code).

Conditional required: jurisdictionState (code) for US risks.

The regulatory risk location is found in the Fiscal & Regulatory section of the slip — this represents where the regulator deems the risk to be situated, NOT the territory field.

Show Child Parameters
programsarray[object]

RI program associations. Supply when the policy is part of one or more RI program structures.

Show Child Parameters
peerReviewRequestobject

Peer review sign-off for the bind.

Show Child Parameters
Example