IdReference

object

Reference to a lookup-backed entity identified by id (the XFI lookup id, environment-specific).

* Additional properties are NOT allowed.
idstringrequired

XFI lookup id — the canonical identifier (environment-specific).

Example:260

Example

CodeReference

object

Reference to a lookup-backed entity identified by code (the environment-stable business code).

* Additional properties are NOT allowed.
codestringrequired
Example

SubmissionInsured

object

Insured details for the shell submission.

Option A — Existing contact: Set insureContacts.id to the XFI contact identifier. All other insured fields are ignored.

Option B — New insured: Provide companyName, domicileCountry, domicileState, and any available mailing-address fields. insureContacts must be omitted.

companyNamestring

Required when creating a new insured (i.e. insureContacts is not provided). Legal company name as stated in the submission documentation.

Example:Veritas Capital

domicileCountryobject

Required when creating a new insured. Domicile country — always send as code, e.g. { "code": "USA" }. Represents the country where the insured is legally domiciled.

Example:{"code":"USA"}

Show Child Parameters
domicileStateobject

Required when creating a new insured and the domicile country has state-level data. Domicile state — always send as code, e.g. { "code": "NY" }.

Example:{"code":"NJ"}

Show Child Parameters
mailingAddress1string

Example:123 Cedar Street

mailingAddressCitystring

Example:Green Bay

emailstring(email)

Optional if insureContacts is provided.

Example:underwriting@veritascap.com

zipCodestring

Post code / zip for the insured mailing address. Required when creating a new insured and the insured’s country uses postal codes.

Example:54304

obligorobject

Conditional — Political Risk only. Obligor contact reference — id only.

* Additional properties are NOT allowed.
Show Child Parameters
insureContactsobject

Insured contact reference — id only (e.g. { "id": "2000887" }). Use this to reference an existing insured in XFI. When supplied, all other insured fields (companyName, domicile, mailing address) are ignored.

* Additional properties are NOT allowed.
Show Child Parameters
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

SubmissionPolicy

object

Policy node. effectiveDate, expiryDate, currency, product, territory are mandatory.

effectiveDatestring(date)required

Required. Policy effective date (ISO 8601). Source: policy terms section of the slip.

Example:2024-01-01

expiryDatestring(date)required

Required. Policy expiry date (ISO 8601). Source: policy terms section of the slip.

Example:2025-01-01

currencyobjectrequired

Required. Currency reference — code only (e.g. USD, GBP, EUR).

* Additional properties are NOT allowed.
Show Child Parameters
productobjectrequired

Required. Product reference — id only.

* Additional properties are NOT allowed.
Show Child Parameters
territoryobjectrequired

Required. Territory reference — code only.

* Additional properties are NOT allowed.
Show Child Parameters
Example