Search
K
Policy

Charge

object
chargeTypestring

Allowed values:COSTOFINSURANCEEXPENSECHARGEUNITEXPENSECHARGERIDERCHARGESURRENDERCHARGEWITHDRAWALCHARGEPAYMENTCHARGECOVERAGECHARGECOVERAGECREDITPREMIUMTAXMARKETVALUEADJUSTMENT

chargeWaiverIndicatorstring

Allowed values:YesNo

chargeWaiverReasonstring

The reason why a charge was waived (e.g., Promotional Waiver, Policy Exception)

Example:100

Example

Url

object
websitestring

Carrier or Third party administrator website

Example:https://zinnialive.com/

carrierLoginstring

Carrier login

Example:https://zinnialive.com/

agentLoginstring

Agent login

Example:https://zinnialive.com/

customerLoginstring

Customer login

Example:https://wellabe.mypolicyview.com/

Example

BankDetails

object
recordIDnumberrequired
appliesToPartyIDstringrequired
financialInstitutionPartyIDstringrequired
startDatestringrequired
endDatestringrequired
nameOnAccountstringrequired
accountStatusstringrequired
accountTypestringrequired
accountNumberstringrequired
routingNumberstringrequired
ibaNumberstringrequired
branchNamestringrequired
accountPurposestringrequired
branchAddressobjectrequired
Show Child Parameters
branchPhoneNumberstringrequired
Example

RiskDetails

object
existingLifeInsurancebooleanrequired
existingLifeInsuranceAmountnumberrequired
replaceLifeInsurancebooleanrequired
pendingOrPlanToBuyAdditionalbooleanrequired
isDependentbooleanrequired
employedbooleanrequired
employmentStatusstringrequired
occupationstringrequired
householdIncomenumberrequired
Example

Payor

object
idstringrequired
policyDetailsIdstringrequired
ledgerDocIdstringrequired
timestampstring(date-time)required
policyNumberstringrequired
partyMasterIDstringrequired
partyIDstringrequired
idReferenceNostringrequired
beneficiaryPercentagenumberrequired
partyTypestringrequired
urlobjectrequired
Show Child Parameters
firstNamestringrequired
middleNamestringrequired
lastNamestringrequired
fullNamestringrequired
prefixstringrequired
suffixstringrequired
genderstringrequired
dateOfBirthstringrequired
attainedAgenumberrequired
birthCountrystringrequired
birthStatestringrequired
dbastringrequired
abbrNamestringrequired
orgCodestringrequired
entityTypestringrequired
trustDatestringrequired
trustTypestringrequired
prefCommunicationTypestringrequired
formerNameobjectrequired
Show Child Parameters
identificationsarray[object]required
Show Child Parameters
addressesarray[object]required
Show Child Parameters
phonesarray[object]required
Show Child Parameters
emailsarray[object]required
Show Child Parameters
bankDetailsarray[object]required
Show Child Parameters
dateOfDeathstringrequired
stateOfDeathstringrequired
disabledbooleanrequired
disabilityStartDatestringrequired
riskDetailsobjectrequired
Show Child Parameters
financialInstitutionPartyIDstringrequired
percentagenumberrequired
versionnumberrequired
Example