Search
K
Dev API (For Internal IT Users Only)

Reinstatements

object

Reinstatement configuration for a quote section.

reinstatementsApplicableboolean

Example:true

unlimitedReinstatementsboolean
noOfReinstatementsinteger(int32)

Example:1

availableReinstatementsinteger(int32)

Example:1

proRataboolean

Example:true

reinstatementPercentnumber(double)

Example:100

Example

RegulatoryCoding

object

Regulatory coding (code split) line within a quote section.

codestringrequired

Required. Regulatory / risk classification code (e.g. ‘E2’, ‘7T’). Source: the agreement’s risk classification code set.

Example:E2

codeSplitPcnumber(double)required

Required. Code split percentage for this regulatory coding entry (numeric). All entries across the section must sum to 100.

Example:50

overrideAgreementRiskCodeboolean

Set true to override the agreement’s default risk code with this entry. Default is false.

gELRnumber(double)

Optional. gELR (gross expected loss ratio) for this regulatory coding entry, when it differs from the section-level gELR.

Example:50

Example

SectionMarketSplit

object

A single carrier entry in a section-level market split.

careerPercentnumber(double)

Carrier percentage share for this section. All entries across the section’s marketSplit must sum to 100.

Example:60

carrierobject

Carrier syndicate — code only (e.g. { "code": "1609" }).

* Additional properties are NOT allowed.
Show Child Parameters
carrierReferencestring

Carrier’s own policy reference.

Example:MR-CYB-2026-001

Example

InsuredEnrichment

object

Bind-time insured enrichment fields (Step 4 only). Carries the additional insured attributes entered in XFI at bind — occupation, LOB-specific details, issuance address, policyholder type, and tax identification numbers. The core contact fields (companyName, domicile, mailing address) are already on the draft from Step 1 and do not need to be re-sent.

occupationSourceobjectrequired

Required. Occupation source — id only. Identifies the source system used for the occupation lookup (e.g. D&B). Source: XFI Contact (General) > Insured section.

* Additional properties are NOT allowed.
Show Child Parameters
occupationobjectrequired

Required. Insured occupation — code only. Enter as sourced from D&B lookup or submission documentation.

* Additional properties are NOT allowed.
Show Child Parameters
assetsUnderManagementstring

Required for FI LOB. Assets under management (string). Source: booking sheet or Tyche rater.

Example:500000000

assetSizestring

Required for FI LOB. Asset size (string). Source: booking sheet or Tyche rater.

Example:1000000000

webSitestring

Required for CY LOB. Insured website URL. Source: submission documentation or insured.

Example:https://www.veritascap.com

policyholderTypeobject

Policyholder type — id only. Source: fiscal/regulatory section of the slip.

* Additional properties are NOT allowed.
Show Child Parameters
issuanceAddressSameAsInsuredboolean

Set true to copy the insured address to the issuance address (Direct business). Set false and supply issuanceTo, issuanceAddress1, issuanceCity, etc. for Assumed / RI business.

Example:true

issuanceTostring

Conditional. Reassured name on the issuance address — populate when issuanceAddressSameAsInsured is false.

Example:Munich Re

issuanceAddress1string

Conditional. Issuance address line 1 — populate when issuanceAddressSameAsInsured is false.

Example:Koeniginstrasse 107

issuanceAddress2string

Conditional. Issuance address line 2 — populate when issuanceAddressSameAsInsured is false.

Example:PO Box 123

issuanceCitystring

Conditional. Issuance address city — populate when issuanceAddressSameAsInsured is false.

Example:Munich

issuanceStateobject

Conditional. Issuance address state — id only. Populate when issuanceAddressSameAsInsured is false.

* Additional properties are NOT allowed.
Show Child Parameters
issuancePostCodestring

Conditional. Issuance address post code — populate when issuanceAddressSameAsInsured is false.

Example:80802

issuanceDateReviewedstring(date)

Conditional. Date the issuance address was reviewed — populate when issuanceAddressSameAsInsured is false.

Example:2026-07-01

mailingAddress2string

Second mailing address line.

Example:Suite 400

mailingAddressCountryobjectrequired

Required. Insured mailing address country — code only. Also mandatory for BDX reporting when insured has exposure in Spain, Portugal, Italy, or Canada.

* Additional properties are NOT allowed.
Show Child Parameters
mailingAddressStateobject

Required for US and Canada insureds. Mailing address state — code only.

* Additional properties are NOT allowed.
Show Child Parameters
mailingAddressPostCodestring

Insured mailing address post code / zip. Supply for US insureds and any other country where postal codes apply.

Example:54302

feinstring

Federal Employer Identification Number (US).

<= 10 characters

Example:12-3456789

taxIdSpainstring

Spanish Tax Identification Number (NIF/NIE). Mandatory per Lloyd’s coverholder reporting standard when insured has Spain exposure.

<= 9 characters

Example:A12345678

taxIdItalystring

Italian Tax Identification Number (Codice Fiscale). Mandatory per Lloyd’s coverholder reporting standard when insured has Italy exposure.

<= 16 characters

Example:RSSMRA85T10A562S

taxIdPortugalstring

Portuguese Tax Identification Number (NIF). Mandatory per Lloyd’s coverholder reporting standard when insured has Portugal exposure.

<= 9 characters

Example:123456789

canadianBusinessNumberstring

Canadian Business Number (BN). Required for any Canadian insured or where risk is located in Canada. Does NOT apply when a Canadian broker is involved in the placement.

<= 9 characters

Example:123456789RT0001

Example

SurplusBroker

object

Surplus and sub-producer details for US-origin risks. Required when risk premium originates from the United States. Note: surplusLinesBroker is the surplus lines broker entity — distinct from the main insurance producer in SubmissionRequest.producer.

typeOfAdmittedobject

Required (US-origin risks). US admitted classification — id only. Set to ‘Surplus’ for US surplus lines business. Source: fiscal/regulatory section of the slip.

* Additional properties are NOT allowed.
Show Child Parameters
surplusLinesBrokerobject

Required (US-origin risks). Surplus lines broker entity — id only. Search and match in XFI by broker name and address. If not found, request addition via the WNS leads process.

* Additional properties are NOT allowed.
Show Child Parameters
brokerLicensestring

Required (US-origin risks). Surplus lines broker licence number as stated on the slip. Query the broker directly if the licence number is missing.

Example:SL-CA-12345

slaNumberstring

Required when producerHomeState is New Jersey. NJ SLA Transaction Number. Format: {5-character SLA}-{YY}-{5-digit sequence} (e.g. ‘AB123-26-00001’).

Example:AB123-26-00001

producerHomeStateobject

Required (US-origin risks). State of filing (producer home state) — code only. Source: fiscal/regulatory section of the slip.

* Additional properties are NOT allowed.
Show Child Parameters
Example