Search
K
UAT APIs

FieldLookupResponse

object

Response returned by /reference/fields. Contains the field name resolved by the server and the list of allowed values read from the live XFI section schema.

statusstringrequired

Outcome of the lookup call.

Allowed values:SUCCESSFAILED

Example:SUCCESS

fieldstringrequired

The XFI field name whose allowed values are returned. One of coverage, agreement, agreementActivity, or agreementSection.

Example:agreement

valuesarray[object]required

A single lookup value entry

Show Child Parameters
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.

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