Search
K
UAT APIs

ContactFuzzySearchResponse

object

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

ContactLiaisonItem

object

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

Example

ContactLiaisonRequest

object

Broker contact person details used to search for or create a contact liaison under a producer.

firstNamestringrequired

First name of the broker contact person.

Example:John

lastNamestringrequired

Last name of the broker contact person.

Example:Smith

fullNamestring

Full name of the broker contact person (optional, used for display).

Example:John Smith

emailstring

Email address of the broker contact person.

Example:john.smith@broker.com

phoneNostring

Phone number of the broker contact person.

Example:+44 20 7946 0958

mobilePhonestring

Mobile phone number of the broker contact person.

Example:+44 7700 900000

Example

ContactLiaisonResponse

object

Response returned after creating or updating a contact liaison for a producer.

producerContactKeystring

XFI contact key of the producer (broker company).

Example:2000556

contactLiaisonKeystring

XFI contact liaison key. Use this value as the producerContact when creating a policy.

Example:3045678

Example

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