PolicyStatusSummary

object

Summary of a policy returned by the /policies/status endpoint.

policykeyinteger

Internal policy key identifier

Example:1086334

policyactivitykeyinteger

Internal policy key identifier

Example:1141169

accountinteger

Account contact key

Example:4040940

insuredinteger

Insured contact key

Example:4040940

producerinteger

Producer contact key

Example:2000556

productinteger

Product identifier

Example:4

effectiveDatestring(date)

Policy effective date

Example:2026-01-15

expiryDatestring(date)

Policy expiry date

Example:2027-01-15

idinteger

Identifier

policyStatusstring

Current status of the policy

Example:Bound

policyActivityStatusstring

Status of the policy

Example:Bound

errorMessageobject

Present when an XFI error prevents the policy from progressing to its desired state. Use these details to determine the next steps.

Show Child Parameters
Example

PolicyDetailsResponse

object

Response object containing full policy details retrieved from outbound-services-call API.

policyIdstring

Unique identifier of the policy

Example:22170

policyActivityKeystring

Policy activity key identifier

Example:33650

policyEffectiveDatestring(date)

Policy effective date

Example:2026-01-01

policyExpiryDatestring(date)

Policy expiry date

Example:2027-01-01

xfiQuoteReferencestring

XFI quote reference

insuredCompanyNamestring

Name of the insured company

Example:Veritas Capital

producerNamestring

Name of the producer

Example:ABC broking ltd

underwriterEmailstring

Email of the underwriter

Example:rajukumar.sah@dxc.com

underwriterNamestring

Name of the underwriter

Example:Sah, Raju

ProducerCompanystring

Producer company name

Example:ABC broking ltd

producerEmailstring

Email of the producer

Example:chanchal.singh@dxc.com

insuredAddressobject

Address details for insured or producer

Show Child Parameters
producerAddressobject

Address details for insured or producer

Show Child Parameters
policySectionsarray[object]

Policy section containing deductions, coverages, and conditions

Show Child Parameters
producerCompanystring

Producer company name

Example:ABC broking ltd

Example

PolicyAddress

object

Address details for insured or producer

streetstring
street2string
citystring
statestring

Example:New York

zipstring
countryISOAlpha2Codestring
countryISOAlpha3Codestring
stateISOAlpha2Codestring
countrystring

Example:United States

Example

PolicySectionDetail

object

Policy section containing deductions, coverages, and conditions

policyDeductionsarray[object]
Show Child Parameters
policyCoveragesarray[object]
Show Child Parameters
policyConditionsarray[object]
Show Child Parameters
excessnumber
aggregateLimitOfLiabilitynumber
policySectionDescstring

Example:1142

policySectionIdstring

Example:55107

allRiskDeductiblenumber
isUpdatedboolean
updatedboolean
Example

PolicyDeduction

object
deductionRatenumber

Example:30

deductionDescstring

Example:Brokerage ( - )

deductionIdstring

Example:26270

isUpdatedboolean
updatedboolean
Example