Search
K
UAT APIs

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

PolicyReferenceResponse

object

Response returned after generating a policy reference. Contains the generated reference, associated keys, and input echo fields.

createdByinteger(int32)

Contact key of the user who created the reference.

Example:2000574

generatedReferencestring

The generated policy reference string.

Example:PCY2434926AA

insuredstring

Insured contact id echoed from the request.

Example:3000211

policyreferencekeyinteger(int32)

Internal policy reference key identifier.

Example:646

notesstring

Notes echoed from the request.

policyYearstring

Policy year echoed from the request.

Example:26

policyYearNumberinteger(int32)

Policy year number echoed from the request.

Example:26

producerstring

Producer contact id echoed from the request.

Example:2000987

productinteger(int32)

Product identifier.

Example:4

underwriterinteger(int32)

Underwriter contact key.

Example:2000310

Example

LivePolicyResponse

object
policyStatusstringrequired

Example:Live Policy

policyNostringrequired

Example:Q1100077

referencestringrequired

Example:F0025667

policyKeystringrequired

Example:1087748

policyActivityKeystringrequired

Example:1142676

policyActivityStatusstringrequired

Example:Issued

Example