Policy
Get Policy Transaction by ID
get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}
Query Parameters
statusarray[string]
endDatestring
startDatestring
limitnumber
offsetnumber
sortOrderstring
versionnumber
transactionTypestring
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePolicyDetailsChangePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedReissuanceRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedPropertySystematicRiderClaimWithdrawalSetupSystematicRiderClaimWithdrawalTaxWithholdingChangeMultipleTrusteeChangeMultiplePowerOfAttorneyChangeOtherInterestedPartyChangeMultipleAuthorizedSignatoryChangeAuthorizedSignatoryChangeExchangeCompanyChangeBillingFeatureChangeGWBPhaseChange
Path Parameters
planCodestringrequired
policyNumberstringrequired
transactionIdstringrequired
Response
application/json
Response
application/json
OK
Transaction
transactionIdstring
A unique identifier assigned to every transaction within the system, used to track and reference individual actions such as premium payments, policy updates, or claims etc
Example:93
originalTransactionIdstring
1
Example:The unique identifier of the reversed transaction. When a transaction is reversed, this field holds the ID of the original transaction that was reversed. We capture this to ensure proper tracking and auditing of financial adjustments within the system
partyPolicyChangeReferenceIdstring
Unique identifier for the impacted party data being updated with a transaction or event. For example, if multiple addresses are modified, this field identifies the specific address Id for which change is being processed
Example:1
partyPolicyNewReferenceIdstring
Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added
Example:1
planCodestring
A code that represents the specific type of life insurance plan or annuity plan
Example:PLAN001
policyNumberstring
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:POLICY1234567890
correlationIdstring
The unique ID to track each transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
parentIdstring
The unique identifier of a Parent Transaction or Parent Program ID. The value of parentId varies based on the transaction type. >>For Subsequent Premium, One-Time Premium, Loan Repayment (One-Time & Systematic) → The Parent Payment Transaction ID is stamped. >> For Forceout and Disbursement → The Parent Money Out or Money In Transaction ID is stamped
Example:Arr_1
transactionTypestring
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePolicyDetailsChangePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedReissuanceRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedPropertySystematicRiderClaimWithdrawalSetupSystematicRiderClaimWithdrawalTaxWithholdingChangeMultipleTrusteeChangeMultiplePowerOfAttorneyChangeOtherInterestedPartyChangeMultipleAuthorizedSignatoryChangeAuthorizedSignatoryChangeExchangeCompanyChangeBillingFeatureChangeGWBPhaseChange
systematicOrBillingChangeIndicatorboolean
Indicates whether a transaction results in any setup, update, or modification to a systematic program or billing change. This field is set to true whenever any part of the systematic program or billing is modified, including changes to its configuration or associated fields
requestDatestring(date)
The date when the transaction request was initiated or received in the system. For example, for system generated events date on which transaction was initiated by the system for adhoc events date on which transaction was received by the system.
Example:2023-01-01
effectiveDatestring(date)
The date when the transaction takes effect on the policy or contract.
Example:2023-01-01
processDatestring(date)
The date when the system actually processes the transaction. This may differ from the request or effective date due to business rules, batch cycle date, business day calender or reversals
Example:2023-01-01
reversalDatestring(date)
The date when a transaction is reversed in the system
Example:2023-01-01
statusstring
Allowed values:PendingCompletedFailedReversedCanceledPendingReversal
outcomestring
Allowed values:truefalse
outcomeCodestring
A system-generated code that corresponds to the transaction outcome when transaction is cancelled
Example:true
outcomeCodeDescriptionstring
A detailed explanation of the outcome, providing context for why a transaction was cancelled
Example:precheck validations failed
transactionReasonstring
The justification or business reason for the transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEFACEINCREASECOVERAGEMECAUTHORIZATIONINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTGWBRIDERDISBURSEMENTGWBPHASECHANGEPREMIUMLOANPAYMENTDUEDATEAMOUNTFREQUENCY
transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
Show Child Parameters
payoutInformationobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsobject
Show Child Parameters
fundActivitiesobject
Show Child Parameters
matchActivityobject
Show Child Parameters
loanActivityobject
Show Child Parameters
taxBasisobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
featuresarray[object]
Show Child Parameters
featureOptionstring
Allowed values:LIFEONLYJOINTLIFEONLYJOINTANDSURVIVORPERIODCERTAINAMOUNTCERTAINLIFEWITHPERIODCERTAINLIFEWITHCASHREFUNDLIFEWITHINSTALLMENTREFUNDAUTOMATICPOLICYLOANREDUCEDPAIDUPAGEFACEAMOUNTLEGALOPERATIONALCOLLATERALLYASSIGNEDUNSPECIFIEDJOINTLIFEONLYJOINTANDSURVIVORJOINTANDSURVIVORPERIODCERTAINDIVORCEOVERPAYMENTPAIDUPADDITIONCASHMECRESTRICTCOMPLIANCEJOINTLIFECASHREFUNDINTERESTONLYJOINTLIFEINSTALLMENTREFUND
payorsarray[object]
Show Child Parameters
payeeOrBeneficiariesarray[object]
Show Child Parameters
caseIdstring
A unique identifier assigned to a transaction case by external systems such as BPM.
Example:e2eb325f-203b-4d49-b6d5-41072cb66866
partyIdstring
The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)
Example:Party_PI_1
timestampstring
Create or Update timestamp of transaction event
Example:2023-01-01T12:00:00.000Z
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
Example:true
versioninteger(int32)
Version number indicating the number of changes made to policy
Example:1
externalIdentifiersobject
Show Child Parameters
suppressionarray[object]
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}
Authentication
Path Parameters
Query Parameters
application/json
Get Transaction by External Transaction Id
get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}
Path Parameters
planCodestringrequired
policyNumberstringrequired
externalIdstringrequired
externalIdTypestringrequired
Allowed values:ExternalTransactionIdReferenceNumberExternalArrangementId
Response
application/json
Response
application/json
OK
Transaction
transactionIdstring
A unique identifier assigned to every transaction within the system, used to track and reference individual actions such as premium payments, policy updates, or claims etc
Example:93
originalTransactionIdstring
1
Example:The unique identifier of the reversed transaction. When a transaction is reversed, this field holds the ID of the original transaction that was reversed. We capture this to ensure proper tracking and auditing of financial adjustments within the system
partyPolicyChangeReferenceIdstring
Unique identifier for the impacted party data being updated with a transaction or event. For example, if multiple addresses are modified, this field identifies the specific address Id for which change is being processed
Example:1
partyPolicyNewReferenceIdstring
Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added
Example:1
planCodestring
A code that represents the specific type of life insurance plan or annuity plan
Example:PLAN001
policyNumberstring
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:POLICY1234567890
correlationIdstring
The unique ID to track each transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
parentIdstring
The unique identifier of a Parent Transaction or Parent Program ID. The value of parentId varies based on the transaction type. >>For Subsequent Premium, One-Time Premium, Loan Repayment (One-Time & Systematic) → The Parent Payment Transaction ID is stamped. >> For Forceout and Disbursement → The Parent Money Out or Money In Transaction ID is stamped
Example:Arr_1
transactionTypestring
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePolicyDetailsChangePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedReissuanceRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedPropertySystematicRiderClaimWithdrawalSetupSystematicRiderClaimWithdrawalTaxWithholdingChangeMultipleTrusteeChangeMultiplePowerOfAttorneyChangeOtherInterestedPartyChangeMultipleAuthorizedSignatoryChangeAuthorizedSignatoryChangeExchangeCompanyChangeBillingFeatureChangeGWBPhaseChange
systematicOrBillingChangeIndicatorboolean
Indicates whether a transaction results in any setup, update, or modification to a systematic program or billing change. This field is set to true whenever any part of the systematic program or billing is modified, including changes to its configuration or associated fields
requestDatestring(date)
The date when the transaction request was initiated or received in the system. For example, for system generated events date on which transaction was initiated by the system for adhoc events date on which transaction was received by the system.
Example:2023-01-01
effectiveDatestring(date)
The date when the transaction takes effect on the policy or contract.
Example:2023-01-01
processDatestring(date)
The date when the system actually processes the transaction. This may differ from the request or effective date due to business rules, batch cycle date, business day calender or reversals
Example:2023-01-01
reversalDatestring(date)
The date when a transaction is reversed in the system
Example:2023-01-01
statusstring
Allowed values:PendingCompletedFailedReversedCanceledPendingReversal
outcomestring
Allowed values:truefalse
outcomeCodestring
A system-generated code that corresponds to the transaction outcome when transaction is cancelled
Example:true
outcomeCodeDescriptionstring
A detailed explanation of the outcome, providing context for why a transaction was cancelled
Example:precheck validations failed
transactionReasonstring
The justification or business reason for the transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEFACEINCREASECOVERAGEMECAUTHORIZATIONINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTGWBRIDERDISBURSEMENTGWBPHASECHANGEPREMIUMLOANPAYMENTDUEDATEAMOUNTFREQUENCY
transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
Show Child Parameters
payoutInformationobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsobject
Show Child Parameters
fundActivitiesobject
Show Child Parameters
matchActivityobject
Show Child Parameters
loanActivityobject
Show Child Parameters
taxBasisobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
featuresarray[object]
Show Child Parameters
featureOptionstring
Allowed values:LIFEONLYJOINTLIFEONLYJOINTANDSURVIVORPERIODCERTAINAMOUNTCERTAINLIFEWITHPERIODCERTAINLIFEWITHCASHREFUNDLIFEWITHINSTALLMENTREFUNDAUTOMATICPOLICYLOANREDUCEDPAIDUPAGEFACEAMOUNTLEGALOPERATIONALCOLLATERALLYASSIGNEDUNSPECIFIEDJOINTLIFEONLYJOINTANDSURVIVORJOINTANDSURVIVORPERIODCERTAINDIVORCEOVERPAYMENTPAIDUPADDITIONCASHMECRESTRICTCOMPLIANCEJOINTLIFECASHREFUNDINTERESTONLYJOINTLIFEINSTALLMENTREFUND
payorsarray[object]
Show Child Parameters
payeeOrBeneficiariesarray[object]
Show Child Parameters
caseIdstring
A unique identifier assigned to a transaction case by external systems such as BPM.
Example:e2eb325f-203b-4d49-b6d5-41072cb66866
partyIdstring
The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)
Example:Party_PI_1
timestampstring
Create or Update timestamp of transaction event
Example:2023-01-01T12:00:00.000Z
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
Example:true
versioninteger(int32)
Version number indicating the number of changes made to policy
Example:1
externalIdentifiersobject
Show Child Parameters
suppressionarray[object]
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}
Authentication
Path Parameters
application/json
Get Policy Systematic Programs
get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms
Query Parameters
referenceIdstring
referenceTypestring
Allowed values:PartyIdBankIdAddressId
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
OK
arrangementTypestring
Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUTRIDERCLAIMWITHDRAWAL
arrangementIdstring
The unique payment number for payments by the party
Example:Arr_1
allocationOptionTypestring
Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLYSPECIFICFUNDPERCENTAGEFIXEDONLYVARIABLEONLYCURRENTHOLDINGS
reasonstring
Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION
numberOfOccurrencenumber(int32)
Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program
Example:12
disbursementTypestring
Allowed values:GROSSNETNETNET
statusstring
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
paymentFormstring
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEPREMIUMLOAN
frequencystring
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
requestedDatestring(date)
The date on which the request for the systematic program was submitted
Example:2023-01-01
startDatestring(date)
The date when the systematic program begins executing payments or transfers (entered by user)
Example:2023-01-01
endDatestring(date)
The date Special Program ends (Entered by user or determined by LPS based on Account Value)
Example:2023-01-01
previousProgramDatestring(date)
The last date on which a systematic transaction was processed
Example:2023-01-01
optedNextProgramDatestring(date)
A user-selected or modified next payment date, different from the scheduled one
Example:2023-01-01
nextProgramDatestring(date)
The date on which the next payment is scheduled
Example:2023-01-01
amountTypestring
Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAPERCENTMODIFIEDEARNINGSONLYSUNINCOMEMAXIMIZERONLYLBRMAXIMUMSUNINCOMEMAXIMIZERNETONETIMEACCESSNONSUNINCOMEMAXIMIZERLBRSWDMAXIMUMSUNINCOMEMAXIMIZERGROSSONETIMEACCESSYEARTODATEFIXEDEARNINGSEARNINGSLIQUIDITYFIRSTEARNINGSLIQUIDITYLASTGUARANTEEDWITHDRAWALBENEFITFIXEDMODIFIEDEARNINGSACCUMULATEDEARNINGSLIFEEXPECTANCYDEFAULTNUMBEROFUNITS
amountnumber(double)
A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program
Example:600
partyarray[object]
Note -Use systematicProgram.parties field instead of systematicProgram.party
Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired
The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program
Example:arrangementid123
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms
Authentication
Path Parameters
Query Parameters
application/json
Get Systematic Programs by External Transaction Id
get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}
Query Parameters
referenceIdstring
referenceTypestring
Allowed values:PartyIdBankIdAddressId
Path Parameters
planCodestringrequired
policyNumberstringrequired
externalIdstringrequired
externalIdTypestringrequired
Allowed values:ExternalTransactionIdReferenceNumberExternalArrangementId
Response
application/json
Response
application/json
OK
arrangementTypestring
Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUTRIDERCLAIMWITHDRAWAL
arrangementIdstring
The unique payment number for payments by the party
Example:Arr_1
allocationOptionTypestring
Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLYSPECIFICFUNDPERCENTAGEFIXEDONLYVARIABLEONLYCURRENTHOLDINGS
reasonstring
Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION
numberOfOccurrencenumber(int32)
Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program
Example:12
disbursementTypestring
Allowed values:GROSSNETNETNET
statusstring
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
paymentFormstring
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEPREMIUMLOAN
frequencystring
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
requestedDatestring(date)
The date on which the request for the systematic program was submitted
Example:2023-01-01
startDatestring(date)
The date when the systematic program begins executing payments or transfers (entered by user)
Example:2023-01-01
endDatestring(date)
The date Special Program ends (Entered by user or determined by LPS based on Account Value)
Example:2023-01-01
previousProgramDatestring(date)
The last date on which a systematic transaction was processed
Example:2023-01-01
optedNextProgramDatestring(date)
A user-selected or modified next payment date, different from the scheduled one
Example:2023-01-01
nextProgramDatestring(date)
The date on which the next payment is scheduled
Example:2023-01-01
amountTypestring
Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAPERCENTMODIFIEDEARNINGSONLYSUNINCOMEMAXIMIZERONLYLBRMAXIMUMSUNINCOMEMAXIMIZERNETONETIMEACCESSNONSUNINCOMEMAXIMIZERLBRSWDMAXIMUMSUNINCOMEMAXIMIZERGROSSONETIMEACCESSYEARTODATEFIXEDEARNINGSEARNINGSLIQUIDITYFIRSTEARNINGSLIQUIDITYLASTGUARANTEEDWITHDRAWALBENEFITFIXEDMODIFIEDEARNINGSACCUMULATEDEARNINGSLIFEEXPECTANCYDEFAULTNUMBEROFUNITS
amountnumber(double)
A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program
Example:600
partyarray[object]
Note -Use systematicProgram.parties field instead of systematicProgram.party
Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired
The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program
Example:arrangementid123
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}
Authentication
Path Parameters
Query Parameters
application/json
Get Policy Riders
get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/riders
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
OK
timestampstring(date-time)
TBD
Example:2023-01-01T12:00:00.000Z
typestring
Allowed values:BASERIDERBASEINCREASEINTEGRATEDRIDERRIDERINCREASEBENEFITDISCOUNTOTHERUNKNOWN
riderNamestring
The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit
Example:Chronic Illness Accelerated Death Benefit Rider
riderElectedstring
Indicates the election status of the rider on the policy, specifying whether the policyholder has formally elected to include the rider
Example:ELECTED
riderCodestring
A unique identifier or alphanumeric code assigned to the rider
Example:EVGLHR
underwritingStatusstring
Allowed values:APPROVEDDECLINED
unbornChildIndicatorboolean
This will be set to yes if there is no Child rider insured to support Unborn Child
qualifiedAdditionalBenefitboolean
Indicates whether the rider provides a qualified benefit under IRS or insurance regulations
effectiveDatestring(date)
Date on which Rider is selected and becomes effective on the policy
Example:2023-01-01
exerciseDatestring(date)
The date the policyholder elects to use or activate the rider benefit
Example:2023-01-01
terminationDatestring(date)
The date on which the rider coverage ends/ is terminated
Example:2023-01-01
statusstring
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
coverageIdstring
An unique identifier assigned to the rider coverage within an insurance coverage or policy layer
Example:Rider_EVGLCHR
amountnumber
The total benefit amount the rider provides (separate from the base policy’s coverage.)
Example:0
annualBenefitAmountnumber(double)
The maximum benefit amount of the benefit base, policyholder can withdraw each year
Example:0
riderBenefitAmountnumber(double)
The Total Benefit Amount represents the maximum guaranteed amount available under the annuity rider over the life of the contract/rider
Example:0
riderBenefitPercentnumber(double)
The fixed percentage applied to the Rider Benefit Amount to calculate the annual guaranteed benefit amount
Example:100
minimumRiderBenefitAmountnumber(double)
Refers to a guaranteed payout to a beneficiary upon the death of the annuitant, regardless of the contract investment performance, as long as the annuity is in the accumulation phase. Used for Variable annuities
Example:0
growthIncomeBenefitAmountnumber(double)
The Growth Income Benefit value represents the guaranteed income base established under a Guaranteed Minimum Income Benefit (GMIB) rider. It is used to calculate the lifetime income payments the annuitant is entitled to upon annuitization, regardless of the contract actual account value.
Example:0
riderStoredIncomeBalancenumber(double)
Amount that can be withdrawn without reducing the yearly or Lifetime rider benefit amount
Example:0
riderParticipantarray[object]
Note - Use riderParticipants field instead of riderParticipant
Show Child Parameters
additionalBenefitUsageCountnumber(int32)
The number of times the additional benefit has been used.
Example:0
riderParticipantsarray[object]
Show Child Parameters
chargeobject
Show Child Parameters
maximumChronicIllnessBenefitPercentagenumber
The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage
Example:2.5
maximumPeriodicPaymentPeriodnumber
The maximum duration over which payments can be made under the rider ( in Months)
claimStatusboolean
The current status of a claim filed under the rider
nextEvaluationDatestring(date)
The date of the next scheduled review or re-evaluation of an ongoing claim (applicable for riders like chronic illness).
Example:2023-01-01
riderPaymentDatestring(date)
The date the benefit payout under the rider is to be disbursed to the policyholder or beneficiary
Example:2023-01-01
terminalRiderPaymentAmountnumber
The amount paid under the rider benefit.(during a given payout cycle)
Example:0
riderMinimumPaymentAmountnumber
Deprecated - kept for backwards compatibility
Example:0
maximumCriticalIllnessBenefitPercentagenumber
The highest percentage of the policy’s face amount that can be accessed under the critical illness rider
Example:0
tierOneMaximumCriticalIllnessBenefitPercentagenumber
The percentage of the benefit payable under Tier 1 of the critical illness structure (e.g., for mild conditions).
Example:0
tierOneMaximumCriticalIllnessBenefitAmountnumber
The maximum dollar amount payable under Tier 1 benefits
Example:0
tierTwoMaximumCriticalIllnessBenefitPercentagenumber
The percentage of the benefit payable under Tier 2(usually for more severe conditions.)
Example:0
tierTwoMaximumCriticalIllnessBenefitAmountnumber
The maximum dollar amount payable under Tier 2 benefits.
Example:0
tierOneCriticalRiderPaymentDatestring(date)
The date on which the Tier 1 critical illness rider benefit payment is scheduled or was made
Example:2023-01-01
tierOneCriticalRiderPaymentAmountnumber
The amount of benefit paid under the Tier 1 critical illness
Example:0
tierTwoCriticalRiderPaymentDatestring(date)
The date on which the Tier 2 critical illness rider benefit payment is scheduled or was made
Example:2023-01-01
tierTwoCriticalRiderPaymentAmountnumber
The amount of benefit paid under the Tier 2 critical illness
Example:0
coverageLayersarray[object]
Show Child Parameters
remainingBenefitnumber(double)
The remaining benefit amount for the rider. Incremented by Premiums and adjusted by withdrawals.
Example:10.51
additionalBenefitUsedUpboolean
Indicates whether the ADL benefit is utilised on the contract.
totalBenefitnumber(double)
The total guaranteed value the contract owner is entitled to at the end of the GMAB holding period — assuming no disqualifying withdrawals or events.
Example:5.17
payoutOptionstring
Single or Joint Payout (not driven by Owners on the policy, even a jointly owned policy can have single as an option. Used in configuration to set different GMWB benefits for Single and Joint GMWB Amount Types
Allowed values:SINGLEJOINT
benefitPercentnumber(double)
Ties to Withdrawal Reset Benefit % Annual Limit on Calender Processing if GMWB Anniversary Base reset is elected. Equals result of GMWB Benefit % equation box in Withdrawal tab (GMWB) Ku - Payout Factor Percentage of the benefit base that will be available for withdrawal each year
Example:1.23
annualBenefitLimitnumber(double)
GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events
Example:3.43
currentAnnualLimitnumber(double)
GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events
Example:5.45
remainingAnnualLimitnumber(double)
The GMWB amount still available for withdrawal in the current Contract Year without creating an “Excess Withdrawal” situation.
Example:6.75
hypotheticalAnnualLimitnumber(double)
During the riders accumulation phase (before it is exercised), a hypothetical annual withdrawal limit is calculated and displayed on statements to inform the policyholder and assist in their decision to exercise the rider
Example:8.95
phasestring
Indicator for whether the phase is Accumulation (not activated, benefit base is still accruing) or Income (annual limit calculated, benefit bases stop growing). Default value = Accumulation
Allowed values:ACCUMULATIONINCOME
lastResetDatestring(date)
User initiates the Reset, Variables product
Example:2023-01-01
baseobject
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/riders
Authentication
Path Parameters
application/json