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 name (e.g. ‘United States’). Represents the country where the insured is legally domiciled.
Example:United States
Required when creating a new insured and the domicile country has state-level data. Domicile state name (e.g. ‘California’).
Example:California
Example:123 Cedar Street
Example:Green Bay
Optional if insureContacts is provided.
Example:underwriting@veritascap.com
Optional ISO 3166-1 alpha-2 country code.
Example:US
Optional ISO 3166-1 alpha-3 country code.
Example:USA
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
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
SubmissionPolicyFull
Policy node for the Full step — same shape as SubmissionPolicy. The free-text policy description is supplied via the top-level policyDescription field.
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.