Search
K
Dev API (For Internal IT Users Only)

Insured

object
idinteger(int32)required
companyNamestringrequired

>= 0 characters<= 200 characters

domicileCountryobjectrequired

Domicile country — always send as code, e.g. { “code”: “USA” }.

Show Child Parameters
domicileStateobjectrequired

Domicile state — always send as code, e.g. { “code”: “NY” }.

Show Child Parameters
mailingAddress1string

>= 0 characters<= 200 characters

mailingAddressCitystringrequired

>= 0 characters<= 30 characters

emailstringrequired
countryISOAlpha2Codestringrequired

countryISOAlpha2Code must be required

countryISOAlpha3Codestringrequired

countryISOAlpha3Code must be required

Example

Policy

object
effectiveDatestring(date)required
expiryDatestring(date)required
currencyCodestring
productstringrequired
territorystringrequired
Example

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

Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU

Example:Bound

policyActivityStatusstring

Status of the policy

Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU

Example:Bound

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