datestring
viewDetailsboolean
versioninteger
Policy Overview/Details
get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}
Query Parameters
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
Returns data for a specific policy
One Ofidstring
Internal ID of the snapshot document
Example:657bddcddc353e5fc5f45acd
eventstring
The transaction type of the current policy snapshot
Example:InterestCreditMatch
effectiveDatestring(date)
Policy as of effective date (with pattern “yyyy-mm-dd”).
Example:2023-01-01
carrierIdstring
The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms
Example:SB
policyReferenceIdstring
Attribute name storing the policy reference id generated by RDE system
Example:563f35b74b904f87a2e3ddbde0c3c541
thirdPartyAdministratorIdstring
A Third-Party Administrator (TPA) ID is a unique identifier assigned to a third-party administrator that manages insurance policies, claims, and administrative functions on behalf of an insurance carrier. The TPA ID helps identify the organization handling policy services, claims processing, and compliance reporting
Example:tpa-12345
policySourcestring
Policy Source refers to the origin or method by which a life insurance or annuity application was initiated and submitted, often used to identify how the policy entered the underwriting or issuance workflow. It reflects the channel, system, or direction of application flow, such as inbound or outbound underwriting
Example:Outbound
policySourceDescriptionstring
Policy Source Description provides detailed contextual information about the origin of a policy application, supplementing the high-level Policy Source value. It includes specific identifiers or descriptive data such as the underwriter’s name, referral source, agency, platform, or originating system that processed or submitted the application
Example:Underwriter name
productobject
Show Child Parameters
bandingstring
Banding refers to the grouping of policy coverage amounts into different tiers or “bands” that impact pricing, underwriting, and premium rates. It is commonly used in life insurance pricing models to offer lower per-unit costs for higher coverage amounts
Allowed values:NOPREMIUMBANDING
matchBonusVersionstring
The Match Bonus Version refers to the specific version of match bonus rates applied to a policy or annuity, based on the release date of that rate structure. It ensures that the correct bonus percentage, eligibility criteria, and payout structure are applied according to the policy’s issue date and applicable rate updates
Example:2021.10.15
qualificationTypestring
Qualification type of original policy being exchanged
Allowed values:INDIVIDUALRETIREMENTACCOUNTREGULARINDIVIDUALRETIREMENTACCOUNTSPOUSALINDIVIDUALRETIREMENTACCOUNTROLLOVERROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALINDIVIDUALRETIREMENTACCOUNTCUSTODIALROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNTQUALIFIEDNONQUALIFIEDSIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNTINHERITEDINDIVIDUALRETIREMENTACCOUNTINHERITEDROTHINDIVIDUALRETIREMENTACCOUNTNONQUALIFIEDSTRETCHINDIVIDUALRETIREMENTACCOUNTSIMPLEQ403BQ401KQ401AQ457BPENSIONPLANCONVERTEDINDIVIDUALRETIREMENTACCOUNTROTH403BCUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSIONKEOGH10CORPORATEPENSIONGROUPTAXSHELTEREDANNUITYPROFITSHARINGTARGETBENEFITCORPORATEDEFERREDCOMPENSATION404EDUCATIONALINDIVIDUALRETIREMENTACCOUNTQN457BCONVERTEDSPOUSALCUSTODIALUNIFORMGIFTSORTRANSFERSTOMINORACT
policyTermnumber(int32)
The Policy Term refers to the number of years a life insurance or annuity contract remains active under its defined premium payment structure. It can represent the fixed duration of a term policy or the maximum period for premium payments in a permanent or flexible premium plan
Example:20
policyYearnumber(int32)
The Policy Year refers to the number of years that have passed since the policy’s effective date. It is used to track policy duration, benefits, premium schedules, surrender charges, and other contractual provisions
Example:1
monthOfYearnumber(int32)
The Policy Months refers to the number of months that have passed since the policy’s effective date. It is used to track policy duration, premium schedules, benefits, and contractual provisions on a monthly basis
Example:2
policyNumberstring
The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime
Example:ZH12345678
parentPolicyNumberstring
The Parent Policy Number is the unique identifier of the original or source insurance policy or contract from which the current policy has been derived, continued, or linked. It serves as a reference point for tracking policy lineage, inheritance, or transformation, and is used to establish relationships between multiple policies
Example:ZNQA12134
priorPolicyNumberstring
The unique identifier of the original policy number of a policy in the case of a conversion, replacement, exchange or reissue
Example:ZNQA12134
policyStatusstring
Allowed values:PENDINGISSUEDNOTISSUEDCANCELEDNOPREMIUMACTIVECANCELEDFREELOOKPENDINGLAPSELAPSETERMINATEDMATUREDSURRENDEREDLIVINGCLAIMPENDINGDEATHCLAIMPENDINGDEATHCLAIMPAIDNOTTAKENISSUEDPARTIALDEATHCLAIMPAYOUT
restrictStatusstring
Allowed values:LEGALOPERATIONAL
issueTypestring
Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEEISSUEREDUCEDUNDERWRITINGEXPRESSUNDERWRITINGMASSUNDERWRITINGAVIATION
issueStatestring
Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY
currencystring
Allowed values:USDCADAUDNZDGBPEURCHFJPY
policyDatesobject
Show Child Parameters
costBasisobject
Show Child Parameters
fixedCostPeriodnumber(int32)
The Fixed Cost Period refers to the initial guaranteed period (e.g., 10, 20, or 30 years) after the policy start date during which the Protection Costs (Cost of Insurance - COI) remain unchanged or are not charged. Once this period ends, the policy enters the Post Fixed Period, where costs may increase
Example:10
commissionOptionstring
Allowed values:OPTIONAOPTIONBNOCOMMISSIONSTANDARDTRAIL
accountValuesobject
Show Child Parameters
loanValuesobject
Show Child Parameters
withdrawalValuesobject
Show Child Parameters
marketValueAdjustmentobject
Show Child Parameters
requiredMinimumDistributionobject
Show Child Parameters
testValuesobject
Show Child Parameters
timestampstring(date-time)
Example:2023-01-01T12:00:00.000Z
deathBenefitobject
Show Child Parameters
coverageobject
Show Child Parameters
ridersarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
systematicProgramsarray[object]
Show Child Parameters
policyFeaturesarray[object]
Show Child Parameters
allocationobject
Show Child Parameters
versioninteger(int32)
Version number
Example:1
partyRolesarray[object]
Array of party roles
Show Child Parameters
partiesarray[object]
Array of parties
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}
Authentication
Path Parameters
Query Parameters
application/json
Details
Get policy details
Transactions
get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions
Query Parameters
reverseInitiatorOnlyboolean
statusarray[string]
endDatestring
startDatestring
limitinteger
offsetinteger
sortFieldstring
Allowed values:EFFECTIVEDATEPROCESSDATEREVERSALDATE
sortOrderstring
Allowed values:ASCDESC
versioninteger
transactionTypesarray[string]
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
OK
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:SBFIXUL1
policyNumberstring
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:AU12345678
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:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
systematicOrBillingChangeIndicatornumber
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
Allowed values:true
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:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
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
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
get/policy/v1/policies/{planCode}/{policyNumber}/transactions
Authentication
Path Parameters
Query Parameters
application/json
Transaction By Id
get
https://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:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
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:SBFIXUL1
policyNumberstring
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:AU12345678
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:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
systematicOrBillingChangeIndicatornumber
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
Allowed values:true
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:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
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
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
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}
Authentication
Path Parameters
Query Parameters
application/json
Transaction by External Transaction Id
get
https://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:SBFIXUL1
policyNumberstring
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:AU12345678
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:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
systematicOrBillingChangeIndicatornumber
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
Allowed values:true
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:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
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
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
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}
Authentication
Path Parameters
application/json