Void Transaction (Synchronous)

Voids a policy. Eligibility: The policy can only be voided when its status is Submission In Clear or Quote In Preparation.

Response timing

Expected API response time is two minutes or less, subject to XFI availability and performance.

post
https://apinonprod.mosaicinsurance.com/policy/void

Query Parameters

policyKeystringrequired

Policy key

Example:1089434

policyActivityKeystringrequired

Policy activity key

Example:1144621

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Response

application/json

Policy voided successfully

policykeystringrequired
policyactivitykeystringrequired
policyStatusstringrequired
policyActivityStatusstringrequired
post/policy/void
 
application/json

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.

get
https://apinonprod.mosaicinsurance.com/lookup/contacts

Query Parameters

roleCodestringrequired

XFI role code to filter contacts by. See description for full list.

Allowed values:INSATTACCPRDTAXOTHCLMREINBCTUSREWIAEACAAGRPIBINSDIVSYNTCCSRVCOVLFAUDEXUSRFRCBASASOSOFFTEAMOBGLGRGAINVFINTADENVITAINABENADOACFUWCBUYSELTGTPTFREINDSCMPEBMBK

Example:USR

contactReferencestring

Optional partial match on contact name or code (e.g. “Enbridge Inc.”, “MSR”).

Example:Enbridge Inc.

pageinteger

Page number, 1-based. Defaults to 1.

Default:1

>= 1

Example:1

pageSizeinteger

Number of results per page. Defaults to 25. Maximum 100.

Default:25

>= 1<= 100

Example:25

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Response

application/json

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.

totalinteger(int32)required

Total number of matching contacts reported by XFI (_count).

itemarray[object]required

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.
get/lookup/contacts
 
application/json

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.

get
https://apinonprod.mosaicinsurance.com/lookup/liaison

Query Parameters

producerContactKeystringrequired

XFI contact key of the producer (broker company).

Example:2000556

pageinteger

Page number, 1-based. Defaults to 1.

Default:1

>= 1

Example:1

pageSizeinteger

Number of results per page. Defaults to 25. Maximum 100.

Default:25

>= 1<= 100

Example:25

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Response

application/json

Contact liaisons retrieved successfully.

A single contact liaison entry for a producer.

contactliaisonkeyinteger

XFI contact liaison key.

Example:2596

contactkeyinteger

XFI contact key of the producer.

Example:2000556

contactstring

Producer company name.

Example:Lockton Companies, LLC

liaisonRolestring

Role of the liaison (e.g. Broker Contact).

Example:Broker Contact

contactLiaisonReferencestring

Display name (LastName, FirstName).

Example:Ahn, Paul

firstNamestring

Example:Paul

lastNamestring

Example:Ahn

emailstring

Example:pahn@lockton.com

get/lookup/liaison
 
application/json

Policy

Create, retrieve, and search policies across the lifecycle.