IdReference
objectReference to a lookup-backed entity identified by id (the XFI lookup id, environment-specific).
XFI lookup id — the canonical identifier (environment-specific).
Example:260
CodeReference
objectReference to a lookup-backed entity identified by code (the environment-stable business code).
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
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
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.