Search
K
Policy

MatchSegmentFinancialActivity

object
attributesobjectrequired
Show Child Parameters
Example

ArrangementsMatchSegment

object
attributesobjectrequired
Show Child Parameters
financialActivityobjectrequired
Show Child Parameters
Example

DeathClaimAttributes

object
statutoryInterestAmountstringrequired
payoutPreSupplementalSecurityIncomestringrequired
interestCalculationDatestringrequired
statutoryInterestRatestringrequired
Example

DeathClaim

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

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

Example:2023-01-01

reverseInitiatorboolean

A boolean flag that applies only to financial transactions. When set to true, it allows a backdated transaction to be processed. This triggers a reversal on the policy to the earliest transaction on the specified effective date, applies the new transaction, and then reprocesses all subsequent transactions (similar to (R&R) process). This ensures that the policy`s financial history remains accurate and aligned with the backdated change

Default:false

transactionAmountsobject
Show Child Parameters
transactionReasonstring

The justification or business reason for the transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS

payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
policyobject
Show Child Parameters
externalIdentifiersobject
Show Child Parameters
Example

Arrangements

object
attributesobjectrequired
Show Child Parameters
taxWithHoldingarray[object]required
Show Child Parameters
paymentsarray[object]required
Show Child Parameters
feesarray[object]required
Show Child Parameters
arrangementSourcesarray[object]required
Show Child Parameters
loanSegmentsarray[object]required
Show Child Parameters
matchSegmentobjectrequired
Show Child Parameters
deathClaimobjectrequired
Show Child Parameters
Example