SubmissionInsured
objectInsured 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.
Required when creating a new insured (i.e. insureContacts is not provided). Legal company name as stated in the submission documentation.
Example:Veritas Capital
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
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
Example:123 Cedar Street
Example:Green Bay
Optional if insureContacts is provided.
Example:underwriting@veritascap.com
Post code / zip for the insured mailing address. Required when creating a new insured and the insured’s country uses postal codes.
Example:54304
Conditional — Political Risk only. Obligor contact reference — id only.
Show Child Parameters
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.
Show Child Parameters
SubmissionProducer
objectProducer (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.
Required. XFI contact key of the producer (broker company). id only.
Example:2000556
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
SubmissionPolicy
objectPolicy node. effectiveDate, expiryDate, currency, product, territory are mandatory.
Required. Policy effective date (ISO 8601). Source: policy terms section of the slip.
Example:2024-01-01
Required. Policy expiry date (ISO 8601). Source: policy terms section of the slip.
Example:2025-01-01
Required. Currency reference — code only (e.g. USD, GBP, EUR).
Show Child Parameters
Required. Product reference — id only.
Show Child Parameters
Required. Territory reference — code only.
Show Child Parameters
SectionIdentifierRef
objectSection identifier, identified by id. Ids are fixed and stable across all environments.
1 = C&C, 2 = Non C&C.
Allowed values:12
Example:1
ReferenceTypeRef
objectReference type, identified by id. Ids are fixed and stable across all environments.
1 = EEA, 2 = Non-EEA, 3 = Both.
Allowed values:123
Example:1