Search
K
Policy Transactions

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

DeathClaimParty

object
partyIdstringrequired

Unique identifier for the party

Example:2f356dcc-303d-4fc0-94a2-5369fb62642a

partyRolestringrequired

Allowed values:INFORMANTINSUREDPRIMARYBENEFICIARYCONTINGENTBENEFICIARY

Example:INFORMANT

partyTypestringrequired

Allowed values:INDIVIDUALORGANIZATION

Example:INDIVIDUAL

relationshipToInsuredstring

Allowed values:SPOUSECHILDPARENTSIBLINGOTHER

Example:SPOUSE

isFuneralHomeAssignedboolean

Example:true

personalInformationobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersarray[object]
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

PersonalInformation

object
firstNamestring

Example:Jane

middleNamestring

Example:Marie

lastNamestring

Example:Smith

suffixstring

Example:Jr.

prefixstring

Example:Ms.

dateOfBirthstring(date)

Date (with pattern “yyyy-mm-dd”)

Example:1990-01-01

genderstring

Allowed values:MALEFEMALEOTHER

birthSexstring

Allowed values:MALEFEMALE

birthCountrystring

Example:US

citizenCountrystring

Example:US

Example