Lookups
Look up contacts and allowed field values used across the platform.
Contacts (Synchronous)
Returns XFI contacts filtered by the specified role code. Supports optional free-text filter on contact name/code and page-based pagination via the page/pageSize query parameters (internally translated to XFI’s _start/_num).
Response shape: the response returns total (XFI’s reported match count) and item (the array of matched contacts for this request). item entries are passed through from XFI’s summary object verbatim (not a fixed schema) so any new attribute XFI adds in future is available automatically without an API change; the properties listed below are the common ones.
Common role codes:
| Code | Role |
|---|---|
USR |
Internal User (Underwriters) |
ACC |
Account / Insured |
PRD |
Producer / Broker |
AGR |
Agreement Partner |
OBG |
Obligor |
REIND |
Reinsured |
SCM |
Syndicate Capital Management |
INS |
Insurer |
COV |
Coverholder |
DIV |
Division |
SYN |
Syndicate |
MBK |
Master Broker |
All supported codes: INS, ATT, ACC, PRD, TAX, OTH, CLM, REIN, BCT, USR, EW, IA, EA, CA, AGR, PI, BINS, DIV, SYN, TCC, SRV, COV, LF, AUD, EXUSR, FRC, BA, SA, SOS, OFFTEAM, OBG, LG, RGA, INV, FIN, TAD, ENV, ITA, INA, BEN, ADO, ACF, UWC, BUY, SEL, TGT, PTF, REIND, SCM, PEB, MBK
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
XFI role code to filter contacts by. See description for full list.
Allowed values:INSATTACCPRDTAXOTHCLMREINBCTUSREWIAEACAAGRPIBINSDIVSYNTCCSRVCOVLFAUDEXUSRFRCBASASOSOFFTEAMOBGLGRGAINVFINTADENVITAINABENADOACFUWCBUYSELTGTPTFREINDSCMPEBMBK
Example:USR
Optional partial match on contact name or code (e.g. “Enbridge Inc.”, “MSR”).
Example:Enbridge Inc.
Page number, 1-based. Defaults to 1.
Default:1
>= 1
Example:1
Number of results per page. Defaults to 25. Maximum 100.
Default:25
>= 1<= 100
Example:25
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
Contacts retrieved successfully. Only ‘Active’ and ‘Not Approved’ broker information is pulled from XFI in the Lookup contact by roles endpoint response.
ContactFuzzySearchResponse
Response returned by the /lookup/contacts endpoint. Wraps XFI’s _count/_links.item[].summary payload as total/item.
Total number of matching contacts reported by XFI (_count).
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.
Authentication
Query Parameters
Headers
Contact Liaisons (Synchronous)
Returns all contact liaisons (broker contacts) registered under the specified producer. This is a read-only lookup — no data is created or modified.
Each item in the response contains contactliaisonkey, contactkey, contact, liaisonRole, contactLiaisonReference, firstName, lastName, and email.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
XFI contact key of the producer (broker company).
Example:2000556
Page number, 1-based. Defaults to 1.
Default:1
>= 1
Example:1
Number of results per page. Defaults to 25. Maximum 100.
Default:25
>= 1<= 100
Example:25
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
Contact liaisons retrieved successfully.
A single contact liaison entry for a producer.
XFI contact liaison key.
Example:2596
XFI contact key of the producer.
Example:2000556
Producer company name.
Example:Lockton Companies, LLC
Role of the liaison (e.g. Broker Contact).
Example:Broker Contact
Display name (LastName, FirstName).
Example:Ahn, Paul
Example:Paul
Example:Ahn
Example:pahn@lockton.com
Authentication
Query Parameters
Headers
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.