InstalmentEntry
objectA single entry in a custom instalment plan.
Due date for this instalment.
Example:2026-08-01
Percentage of total premium due on this date. All entries across the instalmentPlan must sum to 100.
Example:25
TaxContactCreation
objectInsured contact details to create in XFI for a specific tax-country entry. Required for Spain, Portugal, Italy and Canada when the insured record is not already present in XFI.
XFI contact type.
Example:Company
Insured company name for this country.
Example:Veritas Capital Spain S.L.
Mailing address country — code only.
Show Child Parameters
Mailing address line 1.
Example:Calle Gran Via 28
Mailing address line 2.
Example:Planta 3
City.
Example:Madrid
State — code only.
Show Child Parameters
Post code.
Example:28013
FonActivity
objectFON (Final Offer & Negotiation) attributes at the policy activity level. CY LOB only. Carries FON date, jurisdiction details, and regulatory location for the insured risk.
Required for FON stage. The date the Final Offer & Negotiation was completed (ISO 8601 date, e.g. ‘2026-07-01’). Provided by the front-end system.
Example:2026-01-15
Required. Jurisdiction country — code only. The country where the insured risk is located. Found in the Fiscal & Regulatory section of the slip. This is NOT the same as the territory field.
Show Child Parameters
Required for US risks. Jurisdiction state — code only. The state where the US-domiciled insured risk is located. Provided by the front-end for US-origin submissions.
Show Child Parameters
Required. Regulatory risk location — code only. Where the regulator deems the risk to be situated, as stated in the Fiscal & Regulatory section of the slip. This is NOT the territory; the two fields serve different regulatory purposes.
Show Child Parameters
FieldLookupResponse
objectResponse returned by /reference/fields. Contains the field name resolved by the server and the list of allowed values read from the live XFI section schema.
Outcome of the lookup call.
Allowed values:SUCCESSFAILED
Example:SUCCESS
The XFI field name whose allowed values are returned. One of coverage, agreement, agreementActivity, or agreementSection.
Example:agreement
A single lookup value entry
Show Child Parameters
ContactFuzzySearchItem
objectA single contact entry returned by the /lookup/contacts endpoint, passed through from XFI’s summary object verbatim. Backing Java type is Map<String, Object> — keys are not fixed/known in advance (XFI may return any of contactKey, contactReference, code, roleCode, mainrole, email, mailingAddress1, mailingAddress2, mailingAddressCity, country, or others), so no fixed property list is declared here.