Search
K
Policy

ApiRequestHeaderValue

object
externalIdstringrequired
externalUserIdstringrequired
externalSystemIdstringrequired
externalUserCompHrchyIdstringrequired
muleCorrelationIdstringrequired
timestampstring(date-time)required
apiRequestUUIDstringrequired
apiNamestringrequired
externalTransactionNamestringrequired
clientCodestringrequired
externalUserIdValidstringrequired
Example

PolicyCommonRequestValue

object
contractNumberstringrequired
companyIdnumberrequired
companyHierarchyIdnumberrequired
planCodestringrequired
policyNumbernumberrequired
cvgIdnumberrequired
Example

StatusValue

object
statusCodestringrequired
statusMessagestringrequired
errorsarray[string]required
Example

AllocationDetailItem

object
dbAmountnumberrequired
dbFixedPctnumberrequired
dbNonLifePayoutExclAmtnumberrequired
dbPctGMWBPaymentnumberrequired
dbPriorMRDAmtnumberrequired
policyNumbernumberrequired
cvgIdnumberrequired
typeOfAllocnumberrequired
startDatestring(date-time)required
termDatestring(date-time)required
modestringrequired
nextDatestring(date-time)required
lastTxnDatestring(date-time)required
termBystringrequired
modePeriodsnumberrequired
amountTypenumberrequired
distributionCodestringrequired
allocationIdnumberrequired
firstPayYearstringrequired
firstPayYearDatestring(date-time)required
calcTypenumberrequired
countnumberrequired
durationnumberrequired
dcaSweepnumberrequired
earningsRefreshDatestring(date-time)required
loanIdnumberrequired
grossDisbIndnumberrequired
programCounternumberrequired
moneySrcIdnumberrequired
firstNextDatestring(date-time)required
waivenumberrequired
waiveMVAnumberrequired
waiveBonusRecapnumberrequired
refundOnlynumberrequired
treatAsNonTaxablebooleanrequired
waiveLimitsnumberrequired
evaluateGMWBAmtnumberrequired
advisorConsultationnumberrequired
featureChangenumberrequired
taxExclTypenumberrequired
firstSSWBasisnumberrequired
priorMRDAmtTypenumberrequired
batchnumberrequired
Example

SpecialProgramDetails

object
apiRequestHeaderobjectrequired
Show Child Parameters
policyCommonRequestobjectrequired
Show Child Parameters
statusobjectrequired
Show Child Parameters
allocationDetailsarray[object]required
Show Child Parameters
Example