Search
K
Policy

SpecialProgramDetails

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

CashValuesItem

object
SourceSystemstringrequired

Allowed values:LC

AsOfDatestring(date-time)required
SurrenderChargenumberrequired
AccountValuenumberrequired
LoanPrinciplenumberrequired
CashValuenumberrequired
CumulativePremiumAmountnumberrequired
MinimumDeathBenefitnumberrequired
GuaranteedMinimumDeathBenefitnumberrequired
DeathBenefitAmountnumberrequired
YtdPremiumAmountnumberrequired
YtdWithdrawalnumberrequired
TotalWithdrawalnumberrequired
GWBnumberrequired
DeathBenefitValuenumberrequired
NetCashSurrenderValuenumberrequired
RequiredMinimumDistributionnumberrequired
GuaranteedCashSurrenderValueIndexnumberrequired
GuaranteedCashSurrenderValuenumberrequired
FreeWithdrawalAmountnumberrequired
FreeWithdrawalRemainingnumberrequired
GuaranteedAnnualPaymennumberrequired
Example

CashValues

object
Itemsarray[object]required
Show Child Parameters
Example

NotesInfo

object
Countnumberrequired
Itemsarray[object]required
Show Child Parameters
Example

PolicyNote

object
idstringrequired

Unique identifier for the note

Example:123e4567-e89b-12d3-a456-426614174000

notePrioritystringrequired

Priority level of the note

Example:High

dateEnteredstring(date-time)required

Date when the note was initially entered

Example:2024-01-15T10:30:00Z

summarystringrequired

Brief summary of the note

Example:Policy review required

noteCategorystringrequired

Category classification of the note

Example:Administrative

noteTypestringrequired

Type classification of the note

Example:Review

notesstringrequired

Detailed note content

Example:Annual policy review is due. Please schedule appointment with policy holder.

rolestringrequired

Role of the person who created the note

Example:Administrator

alertDisableDatestring(date-time)required

Date when the note should be disabled

Example:2024-02-15T10:30:00Z

alertIndicatorbooleanrequired

Whether this note triggers an alert

Example:true

userIdstringrequired

ID of the user who created the note

Example:admin001

timestampstring(date-time)required

Date when the note was last modified

Example:2024-01-15T10:30:00Z

endDatestring(date-time)required

Date when the note expires

Example:2024-02-15T10:30:00Z

Example