Search
K
Policy Transactions

CodeDisplayName

object

Generic code/displayName object

codestring

Code value

Example:WD

displayNamestring

Display name

Example:Withdrawal

Example

ViAmounts

object

VI-derived amount values for withdrawal rule evaluation.
Contains real-time policy values from VI 21209 response.

interestOnlyAmountnumber(decimal)

Interest-only withdrawal amount

Example:500

rmdAmountnumber(decimal)

Required Minimum Distribution amount

Example:1000

riderFreeAmountnumber(decimal)

Rider free amount

Example:200

freeAvailableAmountnumber(decimal)

Free available amount (surrenderValueWithoutMarketValueAdjustment)

Example:300

surrenderFreeAmountATDnumber(decimal)

Surrender-free amount year-to-date

Example:400

surrenderValuenumber(decimal)

Total surrender value

Example:10000

policyValuenumber(decimal)

Total policy value

Example:50000

Example

ViFund

object

VI-derived fund information with withdrawal eligibility

fundCodestring

Fund identifier (ProductCode)

Example:ABAF

fundKeystring

Fund key (SubAccountKey)

Example:SUB123

fundNamestring

Fund name

Example:LVIP American Balanced Allocation Fund

withdrawalsAllowedboolean

Whether withdrawals are allowed from this fund

Example:true

totalValuenumber(decimal)

Total value of the fund

Example:5000

availableFundsAmountnumber(decimal)

Available funds amount

Example:4500

numberOfUnitsnumber(decimal)

Number of units held

Example:100.25

fundRestrictReasonstring

Fund restriction reason if any

isTransferSendAllowedboolean

Whether transfer send is allowed

Example:true

isTransferDestinationAllowedboolean

Whether fund can be a transfer destination

Example:true

Example

InitialDeathClaimRequest

object
correlationIdstring

Unique identifier used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the death claim transaction was originally scheduled or expected to happen. It can be a non-business day

Example:2025-12-15

transactionReasonstringrequired

Reason for the transaction

Allowed values:DEATH_NOTIFICATION

Example:DEATH_NOTIFICATION

externalIdentifiersobject
Show Child Parameters
policyobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
deathNotificationobjectrequired
Show Child Parameters
Example

DeathClaimPolicy

object
policyNumberstringrequired

Example:POL-20251215-001

productTypestringrequired

Type of product

Example:FIXEDINDEXEDANNUITY

lineOfBusinessstringrequired

Line of business

Allowed values:LIFEANNUITY

Example:LIFE

Example