Search
K
UAT APIs

PolicyCoverage

object
policyCoverageDescstring

Example:Security and Privacy Liability

grossWrittennumber

Example:15000

currencystring

Example:USD

policyCoverageIdstring

Example:108136

isUpdatedboolean
updatedboolean
Example

PolicyCondition

object
conditionIdstring

Example:13019

typeOfClauseCodestring
typeOfClauseDescriptionstring

Example:Clause

baseCodestring

Example:LMA 5493

clauseTitlestring

Example:Cyber Exclusion

isUpdatedboolean
updatedboolean
Example

Producer

object
idinteger(int32)required
companyNamestringrequired

>= 0 characters<= 200 characters

Example

SubmissionProducer

object

Producer (broker) reference used on a submission. id identifies the producer (broker company). Optionally include a contactliaison block to attach, create, or update the broker contact liaison recorded on the policy.

idstringrequired

Required. XFI contact key of the producer (broker company). id only.

Example:2000556

contactliaisonobject

Optional. Broker contact liaison to record on the policy. See ContactLiaisonSubmission for the attach/create/update behavior.

Example:{"firstName":"John","lastName":"Smith","email":"Yes@example.com","phoneNo":"9000000000","mobilePhone":"899 898 09","faxNo":"45","state":{"code":"UT"},"city":{"description":"Green Bay"},"region":{"description":"GBR"},"contactliaisonid":{"id":"1234"}}

Show Child Parameters
Example

ContactLiaisonSubmission

object

Broker contact liaison recorded under the producer for this submission. The platform resolves this block one of three ways:

  1. Update by key — supply contactliaisonid.id (an existing liaison key). That liaison is updated in place with the email, phoneNo, and mobilePhone values provided; the platform targets it directly without searching by name. firstName + lastName must also be supplied.
  2. Update by name match — omit contactliaisonid. When firstName + lastName match an existing liaison under the producer, that liaison is updated in place.
  3. Create — omit contactliaisonid and supply a firstName + lastName that do not match any existing liaison; a new liaison is created.

firstName and lastName are required in all three cases.

contactliaisonidobject

Optional. Existing contact liaison key (id only). When supplied, the platform attaches that liaison and all individual fields become optional. Omit to create or update by name match.

* Additional properties are NOT allowed.
Show Child Parameters
firstNamestringrequired

Required when creating a new contact (Mode B). First name of the broker contact person.

Example:John

lastNamestringrequired

Required when creating a new contact (Mode B). Last name of the broker contact person.

Example:Smith

emailstring(email)

Required when creating a new contact (Mode B). Email address of the liaison.

Example:Yes@example.com

phoneNostring

Required when creating a new contact (Mode B). Office/landline phone number of the liaison.

Example:9000000000

mobilePhonestring

Optional. Mobile / cell phone number of the liaison.

Example:899 898 09

faxNostring

Optional. Fax number of the liaison.

Example:45

stateobject

Optional. State where the liaison is located. Always send as code, e.g. { “code”: “UT” }.

Example:{"code":"UT"}

Show Child Parameters
cityobject

Optional. City where the liaison is located. Always send as description, e.g. { “description”: “Green Bay” }.

Example:{"description":"Green Bay"}

Show Child Parameters
regionobject

Optional. Region of the liaison. Always send as description, e.g. { “description”: “GBR” }.

Example:{"description":"GBR"}

Show Child Parameters
Example