Search
K
Policy

IriPolicyParties

object
startIndexnumberrequired

Used for pagination to indicate where the returned page starts within the full result set.

>= 0

itemsCountnumberrequired

Number of records included in the current response page.

>= 0

Example:1

totalItemsCountnumberrequired

Total number of records available that match the request criteria, independent of pagination.

>= 0

Example:1

partiesarray[object]required

Individuals or entities associated with the policy, including identity, relationship, and servicing instructions.

Show Child Parameters
Example

IriTransactionType

string

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:SubsequentPaymentOneTimePremiumPartialWithdrawalOneTimeSystematicPartialWithdrawalRequiredMinimumDistributionOneTimeSystematicRequiredMinimumDistributionFullSurrenderFundTransferFundAllocationsChangeSweepDollarCostAverageNewLoanLoanRepaymentOneTimeSystematicLoanRepaymentAnnuitizationSystematicAnnuityPayoutPayoutAmountChangeServiceChargeRiderChargeValueAdjustmentInterestCreditAddressChangeEmailChangePhoneNumberChangeBeneficiaryChangeOwnerChangeBankAccountChangeCommunicationPreferenceChangeReinstatementLapseOther

IriTransactionStatus

string

A Feature Status in life insurance and annuities indicates the current state or activation condition of a specific feature within a policy or contract. It reflects whether a feature is active, inactive, pending, or restricted, helping insurers, agents, and policyholders track policy functionality

Allowed values:PendingCompletedFailedReversedCanceledPendingReversal

IriTransactionReason

string

The justification or business reason for the transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS

IriTransactionAmountType

string

Indicates how the scheduled amount is defined for the systematic program, such as a fixed amount, percentage, maximum available amount, free withdrawal amount, withdrawal until basis, earnings only, pro rata amount, or modified earnings only.

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLY