Search
K
Dev API (For Internal IT Users Only)

BindRequest

object

Policy-level bind attributes. Supply everything that does not belong to a specific section or line.

Key required fields: prebindSanctionCheckComplete.

claimsAgreementParty is a per-line attribute — supply it on each entry in quoteRequest.lines[], not here (XFI only exposes it at the policy-line level).

Section/line attributes (premiumBasis, typeofClaimBasis, instalmentbasis, leaderPercent, etc.) are carried in quoteRequest — not repeated here.

The optional fon block carries FON-stage policy-activity attributes (CY LOB only). The optional surplusBroker block is required for US-origin risks. The optional proceedToLivePolicy flag moves the policy from bound to live policy when set to true; otherwise the policy remains in bound status.

prebindSanctionCheckCompletebooleanrequired

Required. Confirms the pre-bind sanction check has been completed. Set to true before proceeding to bind. The submission will be rejected if this check has not been completed.

Example:true

proceedToLivePolicyboolean

If the value is true we will move the policy from bound to live policy else policy status will be in bound.

obligorobject

Obligor contact reference — id only.

* Additional properties are NOT allowed.
Show Child Parameters
majorPerilobject

Major peril classification — id only. Server-derived from the risk’s class; supply here to override the derivation.

* Additional properties are NOT allowed.
Show Child Parameters
territoryobject

Territory of the risk — code only (e.g. { "code": "USA" }). Represents the location of the risk, not the regulatory location. When multiple locations exist, use the country with the highest concentration of risk properties. Raise a query to the underwriter if the territory is unclear.

* Additional properties are NOT allowed.
Show Child Parameters
typeofRIBasisobject

Type of RI basis — id only. Required for Assumed (RI) business. Leave blank for Direct business.

* Additional properties are NOT allowed.
Show Child Parameters
priorPendingstring(date)

Prior and pending date (ISO 8601 date string, e.g. ‘2025-01-01’). Required for CY LOB. Leave blank for all other LOBs.

Example:2026-01-01

priorActsboolean

Whether prior acts cover applies to this risk.

Example:true

retroactiveDatestring(date)

Retroactive date (ISO 8601 date string). Only applicable when priorActs is true; leave blank when priorActs is false. Required for PV, CY and PL LOBs. Leave blank for all other LOBs.

Example:2026-01-01

insuredobject

Bind-time insured enrichment — occupation, mailing/issuance address, policyholder type, and TINs.

Required fields: occupationSource (id), occupation, mailingAddressCountry (code).

Conditional required: mailingAddressState (US/Canada); webSite (CY LOB); assetsUnderManagement + assetSize (FI LOB); taxIdSpain / taxIdPortugal / taxIdItaly / canadianBusinessNumber (where insured has exposure in those countries).

Show Child Parameters
surplusBrokerobject

Surplus lines and sub-producer details. Required when risk premium originates from the United States.

Required fields: typeOfAdmitted (id, set to Surplus), surplusLinesBroker (id), brokerLicense, producerHomeState (code).

Additionally required when producerHomeState is New Jersey: slaNumber.

Show Child Parameters
tailEffectiveDatestring(date)

Tail effective date at policy-activity level (ISO 8601 date string). Leave blank unless a tail period applies to this risk.

Example:2026-01-01

fonobject

FON (Final Offer & Negotiation) policy-activity attributes. CY LOB only.

Required FON fields: fonDate (date), jurisdictionCountry (code), riskRegulatoryLocation (code).

Conditional required: jurisdictionState (code) for US risks.

The regulatory risk location is found in the Fiscal & Regulatory section of the slip — this represents where the regulator deems the risk to be situated, NOT the territory field.

Show Child Parameters
programsarray[object]

RI program associations. Supply when the policy is part of one or more RI program structures.

Show Child Parameters
peerReviewRequestobject

Peer review sign-off for the bind.

Show Child Parameters
Example

GlobalSubmissionResponse

object

Minimal response returned after the base Step Function completes.

submissionIdstring(uuid)

Correlation id for tracing the background full + quote executions in logs

Example:9b3f7c1c-1f0a-4e2d-9d7c-2e3a8b4c6d2e

policyNostring

Policy number produced by the base submission step

Example:Q0038456

policyKeystring

Policy key produced by the base submission step, propagated to the async steps

Example:20894

policyActivityKeystring

Policy activity key produced by the base submission step

Example:45632

statusstring

ACCEPTED means the full step is running in background; FAILED means the base step failed

Allowed values:ACCEPTEDFAILED

Example:ACCEPTED

messagestring

Human-readable message

Example:Base submission succeeded. The full step is running asynchronously.

Example

SubmissionStatus

object

Persisted per-step status for a global submission.

submissionIdstring(uuid)

Example:9b3f7c1c-1f0a-4e2d-9d7c-2e3a8b4c6d2e

policyNostring

Example:Q0038456

overallStatusstring

Allowed values:PENDINGRUNNINGBASE_OKFULL_OKQUOTE_OKSUCCESSFAILED

Example:BASE_OK

currentStepstring

Allowed values:BASEFULLQUOTEBINDDONE

Example:FULL

executionArnstring

Example:arn:aws:states:us-east-2:123456789012:execution:TridentGlobalSubmission:fresh-9b3f7c1c-...

policyKeystring

Example:20894

policyActivityKeystring

Example:45632

baseStatusstring

Allowed values:PENDINGSUCCESSFAILED

Example:SUCCESS

baseAttemptsinteger

Example:1

baseErrorstring
baseOutputJsonstring

Raw JSON output of the base step (audit)

fullStatusstring

Allowed values:PENDINGSUCCESSFAILED

Example:PENDING

fullAttemptsinteger
fullErrorstring
fullOutputJsonstring
quoteStatusstring

Allowed values:PENDINGSUCCESSFAILED

Example:PENDING

quoteAttemptsinteger
quoteErrorstring
quoteOutputJsonstring
bindStatusstring

Allowed values:PENDINGSUCCESSFAILED

Example:PENDING

bindAttemptsinteger
bindErrorstring
bindOutputJsonstring
createdAtstring(date-time)

Example:2026-05-04T12:34:56.789Z

updatedAtstring(date-time)

Example:2026-05-04T12:35:01.123Z

Example

ErrorDetail

object
codestring
messagestring
Example

ErrorResponse

object
errorobject
Show Child Parameters
Example