---
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086"
---

OpenAPI specification document.

```json
{"openapi":"3.0.0","paths":{"/policy/v1/policies/search":{"post":{"operationId":"Policy Search","summary":"Search Policies","parameters":[{"name":"sortBy","required":false,"in":"query","description":"field to sort by","schema":{"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"order to sort (asc or desc)","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"number of results to limit to","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","description":"index to start page search at","schema":{"type":"number"}}],"requestBody":{"required":true,"description":"Optional search criteria, none, some, or all criteria can be used. Values cannot be null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySearchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySearchResponse"}}}},"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySearchResponse"}}}}},"security":[{"Auth0":[]}],"tags":["Search"]}},"/policy/v1/policies/{planCode}/{policyNumber}/versions":{"get":{"operationId":"Policy Versions","x-scopes":"read:policy","summary":"Get policy versions","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer"}},{"name":"transactionType","required":false,"in":"query","description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc","schema":{"enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEvent"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Overview"]}},"/policy/v1/policies/{planCode}/{policyNumber}/versions/{version}":{"get":{"operationId":"Policy By Version","summary":"Get Policy By Version","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"version","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Overview"]}},"/policy/v1/policies/{planCode}/{policyNumber}/transactions":{"get":{"operationId":"Transactions","summary":"Get Policy Transactions","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"reverseInitiatorOnly","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"status","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"endDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","required":false,"in":"query","schema":{"type":"integer"}},{"name":"sortField","required":false,"in":"query","schema":{"enum":["EFFECTIVEDATE","PROCESSDATE","REVERSALDATE"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","schema":{"enum":["ASC","DESC"],"type":"string"}},{"name":"version","required":false,"in":"query","schema":{"type":"integer"}},{"name":"transactionTypes","required":false,"in":"query","description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc","schema":{"type":"array","items":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}":{"get":{"operationId":"Transaction By Id","summary":"Get Policy Transaction by ID","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"transactionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"endDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"sortOrder","required":false,"in":"query","schema":{"type":"string"}},{"name":"version","required":false,"in":"query","schema":{"type":"number"}},{"name":"transactionType","required":false,"in":"query","description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc","schema":{"enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}":{"get":{"operationId":"Transaction by External Transaction Id","summary":"Get Transaction by External Transaction Id","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalId","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalIdType","required":true,"in":"path","schema":{"enum":["ExternalTransactionId","ReferenceNumber","ExternalArrangementId"],"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms":{"get":{"operationId":"Systematic Programs","summary":"Get Policy Systematic Programs","parameters":[{"name":"referenceId","required":false,"in":"query","schema":{"type":"string"}},{"name":"referenceType","required":false,"in":"query","schema":{"enum":["PartyId","BankId","AddressId"],"type":"string"}},{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SystematicProgram"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}":{"get":{"operationId":"Systematic Programs for External Transaction Id","summary":"Get Systematic Programs by External Transaction Id","parameters":[{"name":"referenceId","required":false,"in":"query","schema":{"type":"string"}},{"name":"referenceType","required":false,"in":"query","schema":{"enum":["PartyId","BankId","AddressId"],"type":"string"}},{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalId","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalIdType","required":true,"in":"path","schema":{"enum":["ExternalTransactionId","ReferenceNumber","ExternalArrangementId"],"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SystematicProgram"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/riders":{"get":{"operationId":"Riders","summary":"Get Policy Riders","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Rider"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/parties":{"get":{"operationId":"Parties","summary":"Get Policy Parties","parameters":[{"name":"partyRole","required":false,"in":"query","schema":{"enum":["Owner","JointOwner","Annuitant","JointAnnuitant","Payee","Payor","ThirdPartyDesignee","PrimaryBeneficiary","ContingentBeneficiary","Grantor","Trustee","PowerOfAttorney"],"type":"string"}},{"name":"partyId","required":false,"in":"query","schema":{"type":"string"}},{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/lpspayload":{"get":{"operationId":"Policy Illustration Information","summary":"Get Policy LPS Payload","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LPSPayloadResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/features":{"get":{"operationId":"Features","summary":"Get Policy Features","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyFeature"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/distribution":{"get":{"operationId":"Distribution of Investments","summary":"Get Policy Distribution","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"version","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Distribution"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}/coverage":{"get":{"operationId":"Coverage","summary":"Get Policy Coverage","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCoverage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Details"]}},"/policy/v1/policies/{planCode}/{policyNumber}":{"get":{"operationId":"Policy Overview","summary":"Get Policy Details","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}},{"name":"external-data","required":false,"in":"query","description":"Controls external data enrichment (e.g. DTCC) for AMP SOR requests. When false, external data population is skipped.","schema":{"type":"boolean"}},{"name":"date","required":false,"in":"query","schema":{"type":"string"}},{"name":"viewDetails","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"version","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns data for a specific policy","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Policy"},{"$ref":"#/components/schemas/PolicySummary"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs"}},"security":[{"Auth0":[]}],"tags":["Overview"]}},"/policy/v1/policies/{planCode}/{policyNumber}/metrics":{"post":{"operationId":"Metrics","summary":"Policy Metrics","parameters":[{"name":"planCode","required":true,"in":"path","schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyMetricsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyMetricsResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsErrorResponse"}}}},"500":{"description":"Unexpected error occured, please check server logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsErrorResponse"}}}}},"security":[{"Auth0":[]}],"tags":["Metrics"]}},"/policy-inquiry/v1/policies/{policyNumber}/summary":{"get":{"operationId":"IRI Policy Summary","summary":"Get IRI Policy Summary","parameters":[{"name":"associatedFirmId","required":false,"in":"query","description":"Optional firm/linkage identifier (preferred location per IRI).","schema":{"type":"string"}},{"name":"correlationId","in":"header","description":"Unique identifier to trace the request.","required":false,"schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriPolicySummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"500":{"description":"Unexpected error occured, please check server logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}}},"security":[{"Auth0":[]}],"tags":["Policy Summary"]}},"/policy-inquiry/v1/policies/{policyNumber}/values":{"get":{"operationId":"IRI Policy Value","summary":"Get IRI Policy Value","parameters":[{"name":"associatedFirmId","required":false,"in":"query","description":"Optional firm/linkage identifier (preferred location per IRI).","schema":{"type":"string"}},{"name":"correlationId","in":"header","description":"Unique identifier to trace the request.","required":false,"schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriPolicyValue"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"500":{"description":"Unexpected error occured, please check server logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}}},"security":[{"Auth0":[]}],"tags":["Policy Value"]}},"/policy-inquiry/v1/policies/{policyNumber}/parties":{"get":{"operationId":"IRI Policy Parties","summary":"Get IRI Policy Parties","parameters":[{"name":"limit","required":false,"in":"query","description":"Page size (default 50, max 200)","schema":{"type":"number"}},{"name":"startIndex","required":false,"in":"query","description":"Zero-based index of the first record to return","schema":{"type":"number"}},{"name":"associatedFirmId","required":false,"in":"query","description":"Optional firm/linkage identifier (preferred location per IRI).","schema":{"type":"string"}},{"name":"correlationId","in":"header","description":"Unique identifier to trace the request.","required":false,"schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriPolicyParties"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"500":{"description":"Unexpected error occured, please check server logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}}},"security":[{"Auth0":[]}],"tags":["Policy Parties"]}},"/policy-inquiry/v1/policies/{policyNumber}/transactions":{"get":{"operationId":"IRI Policy Transactions","summary":"Get IRI Policy Transactions","parameters":[{"name":"limit","required":false,"in":"query","description":"Page size (default 50, max 200)","schema":{"type":"number"}},{"name":"startIndex","required":false,"in":"query","description":"Zero-based index of the first record to return","schema":{"type":"number"}},{"name":"transactionTypes","required":false,"in":"query","description":"Filter by one or more transaction type codes (comma-separated).","schema":{"type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Filter transactions up to this date (inclusive).","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Filter transactions from this date (inclusive).","schema":{"type":"string"}},{"name":"associatedFirmId","required":false,"in":"query","description":"Optional firm/linkage identifier (preferred location per IRI).","schema":{"type":"string"}},{"name":"correlationId","in":"header","description":"Unique identifier to trace the request.","required":false,"schema":{"type":"string"}},{"name":"policyNumber","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriPolicyTransactions"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}},"500":{"description":"Unexpected error occured, please check server logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IriError"}}}}},"security":[{"Auth0":[]}],"tags":["Policy Transactions"]}}},"info":{"title":"Policy Service","description":"Enterprise level policy service","version":"0.0.21","contact":{}},"tags":[{"name":"Search","description":"Search for policies"},{"name":"Overview","description":"Get policy overview"},{"name":"Details","description":"Get policy details"},{"name":"Metrics","description":"Get policy metrics"}],"servers":[{"url":"https://qa.api.zinnia.io"}],"components":{"securitySchemes":{"Auth0":{"type":"openIdConnect","openIdConnectUrl":"https://login.qa.zinnia.com/.well-known/openid-configuration","x-kong-security-openid-connect":{"config":{"issuer":"https://login.qa.zinnia.com/.well-known/openid-configuration","extra_jwks_uris":["https://login.qa.mypolicyview.com/.well-known/jwks.json"],"issuers_allowed":["https://login.qa.zinnia.com/","https://login.qa.mypolicyview.com/"],"run_on_preflight":true,"scopes_claim":["https://qa.api.zinnia.io/permissions"],"audience_claim":["aud"],"audience_required":["https://qa.api.zinnia.io"],"auth_methods":["bearer"],"scopes":[]},"enabled":true,"protocols":["grpc","grpcs","http","https"]}}},"schemas":{"PolicySearchRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"policy owner first name"},"policyNumber":{"type":"string","description":"number/subjective id of policy. Optionally, you can partial search if SSN is also using partial search (e.g. `*1234`)"},"lastName":{"type":"string","description":"policy owner last name"},"fullName":{"type":"string","description":"policy owner full name. Optionally support partial search"},"policyStatus":{"type":"string","description":"status of policy, needs to be enum"},"planCode":{"type":"string","description":"plan code for policy"},"lastUpdated":{"format":"date-time","type":"string","description":"last time policy was updated"},"createdAt":{"format":"date-time","type":"string","description":"creation time of the policy"},"ssn":{"type":"string","description":"Policy owner social security number. SSN should be 9 digits, or the last four (e.g. `*1234`) when policy number is also last four (partial search)"},"id":{"type":"string","description":"reference id of the policy, fully unique"},"lineOfBusiness":{"type":"string","description":"line of business to search for, options are LIFE or Annuity Product"},"partyIds":{"description":"list of party ids associated with the policy","example":["4fd32e7aecc24888be9c5418d6dc646a","2739e8897e7141189ccd366f7d054ff0"],"type":"array","items":{"type":"string"}},"issueDateFrom":{"type":"string","format":"date","description":"Start date for issue date range query in YYYY-MM-DD format","example":"2024-01-01"},"issueDateTo":{"type":"string","format":"date","description":"End date for issue date range query in YYYY-MM-DD format","example":"2024-12-31"}}},"PolicyReferenceDataModel":{"type":"object","properties":{"policyNumber":{"type":"string","description":"number/subjective id of policy","example":"POLICY1234567890"},"planCode":{"type":"string","description":"plan code for policy","example":"PLAN001"},"productName":{"type":"string","description":"product name of policy","example":"Deluxe Universal Life"},"firstName":{"type":"string","description":"policy owner first name","example":"Nick"},"lastName":{"type":"string","description":"policy owner last name","example":"Burdell"},"fullName":{"type":"string","description":"policy owner full name","example":"Nick Burdell"},"policyStatus":{"type":"string","description":"status of policy, needs to be enum","example":"IGO"},"lineOfBusiness":{"type":"string","description":"line of business, usually LIFE or ANNUITY","example":"LIFE"},"restrictionStatus":{"description":"restriction status in SOR","example":["LEGAL"],"type":"array","items":{"type":"string"}},"carrierId":{"type":"string","description":"4 character id of carrier, also called clientCode or companyCode","example":"EVGL"},"companyName":{"type":"string","description":"Company associated with policyholder","example":"Everglades"},"ssn":{"type":"string","description":"Social security number of policy holder, masked on return"},"productType":{"type":"string","description":"Type of the product","example":"universal"},"lastUpdated":{"format":"date-time","type":"string","description":"last time policy was updated"},"createdAt":{"format":"date-time","type":"string","description":"creation date of the policy"},"id":{"type":"string","description":"reference id of the policy, fully unique","example":"3cc99edada4f4a88be77cef53ba0b3fd"},"partyIds":{"description":"list of party ids associated with the policy","example":["4fd32e7aecc24888be9c5418d6dc646a","2739e8897e7141189ccd366f7d054ff0"],"type":"array","items":{"type":"string"}},"issueDate":{"type":"string","format":"date","description":"Issue date of the policy in YYYY-MM-DD format","example":"2024-09-30"}},"required":["policyNumber","createdAt"]},"PolicySearchResponse":{"type":"object","properties":{"total":{"type":"number","example":121},"count":{"type":"number","example":1},"next":{"type":"string","example":"/policy/v1/policies/search?offset=10&limit=10"},"previous":{"type":"string","example":""},"results":{"description":"array of policy reference data","type":"array","items":{"$ref":"#/components/schemas/PolicyReferenceDataModel"}}},"required":["total","count","next","previous","results"]},"InstanceExceptionModel":{"type":"object","properties":{"id":{"type":"string","description":"Exception identifier","example":"exc-123"},"externalId":{"type":"string","description":"External identifier for the exception","example":"EXT-123"},"status":{"type":"string","description":"Current status of the exception","example":"Open"},"category":{"type":"string","description":"Exception category","example":"Documentation"},"exceptionType":{"type":"string","description":"Type of exception","example":"Technical"},"reason":{"type":"string","description":"Brief reason for the exception","example":"Missing document"},"detailedReason":{"type":"string","description":"Detailed description of the exception reason","example":"Signature missing on page 3 of application form"},"processingReason":{"type":"string","description":"Processing reason for the exception","example":"Requires manual review"},"processingResolution":{"type":"string","description":"Resolution details for processing","example":"Document resent by applicant"},"createdAt":{"type":"string","description":"Date when the exception was created","example":"2023-01-15T10:30:00Z"},"updatedAt":{"type":"string","description":"Date when the exception was last updated","example":"2023-01-16T14:45:00Z"}}},"IdentifierDocument":{"type":"object","properties":{"identifier":{"type":"string","description":"Type of identifier","example":"SSN"},"value":{"type":"string","description":"Value of the identifier","example":"123-45-6789"}}},"CaseSearchModel":{"type":"object","properties":{"applicationType":{"type":"string","description":"Type of application"},"policyNumber":{"type":"string","description":"Policy number to search for","example":"POL123456789"},"requestSubType":{"description":"List of request sub-types to filter by","type":"array","items":{"type":"string"}},"productName":{"description":"List of product names to filter by","type":"array","items":{"type":"string"}},"ssn":{"type":"string","description":"Social Security Number of policy owner"},"ownerName":{"type":"string","description":"Full name of the policy owner","example":"John Doe"},"ownerFirstName":{"type":"string","description":"First name of policy owner","example":"John"},"ownerLastName":{"type":"string","description":"Last name of policy owner","example":"Doe"},"process":{"description":"List of processes to filter by","type":"array","items":{"type":"string"}},"carrier":{"description":"List of carriers to filter by","example":["EVGL"],"type":"array","items":{"type":"string"}},"caseStatus":{"description":"List of case statuses to filter by","type":"array","items":{"type":"string"}},"createdDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case creation date","example":"2023-01-01T00:00:00Z"},"createdDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case creation date","example":"2023-12-31T23:59:59Z"},"updatedDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case update date","example":"2023-01-01T00:00:00Z"},"updatedDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case update date","example":"2023-12-31T23:59:59Z"},"agentFirstName":{"type":"string","description":"First name of the agent","example":"Jane"},"agentLastName":{"type":"string","description":"Last name of the agent","example":"Smith"},"agentSsn":{"type":"string","description":"Social Security Number of agent"},"brokerDealerName":{"type":"string","description":"Name of the broker-dealer","example":"ABC Financial Services"},"caseIds":{"description":"List of case IDs to search for","example":["CASE123","CASE456"],"type":"array","items":{"type":"string"}},"sortBy":{"type":"string","description":"Field to sort results by","example":"createdAt"},"sortDirection":{"type":"string","description":"Direction of sorting (asc or desc)","example":"desc","enum":["asc","desc"]},"offset":{"type":"string","description":"Offset for pagination","example":"0"},"limit":{"type":"string","description":"Limit for pagination - number of results to return","example":"25"},"notInCaseStatus":{"description":"List of case statuses to exclude from results","type":"array","items":{"type":"string"}},"isIncludeSecondary":{"type":"boolean","description":"Whether to include secondary cases","example":true},"primary":{"type":"boolean","description":"Flag to filter for primary cases only","example":true},"exceptions":{"description":"List of exceptions to search for","type":"array","items":{"$ref":"#/components/schemas/InstanceExceptionModel"}},"identifiers":{"description":"List of identifiers to search for","type":"array","items":{"$ref":"#/components/schemas/IdentifierDocument"}},"issueStatus":{"description":"List of exception statuses to search for","type":"array","items":{"type":"string"}},"escalated":{"type":"boolean","description":"Flag to filter for escalated cases only","example":true},"caseGroups":{"description":"List of case groups to search for","type":"array","items":{"type":"string"}}}},"CaseInstanceStageSummary":{"type":"object","properties":{"id":{"type":"string","description":"Stage identifier","example":"stage-123"},"label":{"type":"string","description":"Display label for the stage","example":"Document Review"},"stageStatus":{"type":"string","description":"Current status of the stage","example":"Completed"}}},"PartyDetailsModel":{"type":"object","properties":{"partyRole":{"type":"string","description":"Role of the party in the case","example":"Owner"},"partyType":{"type":"string","description":"Type of party","example":"Individual"},"firstName":{"type":"string","description":"First name of the party","example":"John"},"middleName":{"type":"string","description":"Middle name of the party","example":"A"},"lastName":{"type":"string","description":"Last name of the party","example":"Doe"},"fullName":{"type":"string","description":"Full name of the party","example":"John A Doe"},"prefix":{"type":"string","description":"Name prefix","example":"Mr"},"suffix":{"type":"string","description":"Name suffix","example":"Jr"},"gender":{"type":"string","description":"Gender of the party","example":"Male"},"ssn":{"type":"string","description":"Social Security Number (masked)","example":"XXX-XX-1234"},"percent":{"type":"string","description":"Percentage value associated with the party","example":"50"},"externalId":{"type":"string","description":"External identifier for the party","example":"EXT-PARTY-123"}}},"CaseInstanceSummaryModel":{"type":"object","properties":{"id":{"type":"string","description":"Case instance identifier","example":"case-123"},"templateId":{"type":"string","description":"Template identifier used for the case","example":"template-456"},"carrier":{"type":"string","description":"Insurance carrier name","example":"EVGL Insurance"},"process":{"type":"string","description":"Process name","example":"New Business"},"parentInstanceId":{"type":"string","description":"Parent instance identifier","example":"parent-case-789"},"correlationId":{"type":"string","description":"Correlation identifier","example":"corr-123"},"caseStatus":{"type":"string","description":"Current status of the case","example":"In Progress"},"processSubType":{"type":"string","description":"Process sub-type","example":"New Application"},"policyNumber":{"type":"string","description":"Policy number","example":"POL123456789"},"productName":{"type":"string","description":"Name of the insurance product","example":"Term Life 20"},"primary":{"type":"boolean","description":"Indicates if this is a primary case","example":true},"deleted":{"type":"boolean","description":"Indicates if the case has been deleted","example":false},"stages":{"description":"List of case stages","type":"array","items":{"$ref":"#/components/schemas/CaseInstanceStageSummary"}},"additionalData":{"type":"object","description":"Additional data associated with the case","example":{"key1":"value1","key2":"value2"}},"identifiers":{"description":"List of identifiers for the case","type":"array","items":{"$ref":"#/components/schemas/IdentifierDocument"}},"createdAt":{"type":"string","description":"Date when the case was created","example":"2023-01-15T10:30:00Z"},"updatedAt":{"type":"string","description":"Date when the case was last updated","example":"2023-01-16T14:45:00Z"},"parties":{"description":"List of parties involved in the case","type":"array","items":{"$ref":"#/components/schemas/PartyDetailsModel"}},"exceptions":{"description":"List of exceptions associated with the case","type":"array","items":{"$ref":"#/components/schemas/InstanceExceptionModel"}},"applicationType":{"type":"string","description":"Type of application","example":"policy"},"caseResult":{"type":"string","description":"Result of the case processing","example":"Approved"},"caseResultDetail":{"type":"string","description":"Detailed result information","example":"Approved with standard rates"}},"required":["primary","deleted","additionalData","identifiers"]},"CaseInstanceSummaryResponse":{"type":"object","properties":{"message":{"type":"string","description":"Response message","example":"Success"},"data":{"description":"Array of case instance summaries","items":{"$ref":"#/components/schemas/CaseInstanceSummaryModel"},"type":"array"},"count":{"type":"number","description":"Number of results in the current page","example":10},"offset":{"type":"number","description":"Starting index of the results","example":0},"limit":{"type":"number","description":"Maximum number of results to return","example":25},"total":{"type":"number","description":"Total number of results available","example":100},"status":{"type":"number","description":"HTTP status code","example":200}},"required":["data","count","offset","limit","total","status"]},"CaseStatsSearchModel":{"type":"object","properties":{"applicationType":{"type":"string","description":"Type of application"},"policyNumber":{"type":"string","description":"Policy number to search for","example":"POL123456789"},"requestSubType":{"description":"List of request sub-types to filter by","type":"array","items":{"type":"string"}},"productName":{"description":"List of product names to filter by","type":"array","items":{"type":"string"}},"ssn":{"type":"string","description":"Social Security Number of policy owner"},"ownerName":{"type":"string","description":"Full name of the policy owner","example":"John Doe"},"ownerFirstName":{"type":"string","description":"First name of policy owner","example":"John"},"ownerLastName":{"type":"string","description":"Last name of policy owner","example":"Doe"},"process":{"description":"List of processes to filter by","type":"array","items":{"type":"string"}},"carrier":{"description":"List of carriers to filter by","example":["EVGL"],"type":"array","items":{"type":"string"}},"caseStatus":{"description":"List of case statuses to filter by","type":"array","items":{"type":"string"}},"createdDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case creation date","example":"2023-01-01T00:00:00Z"},"createdDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case creation date","example":"2023-12-31T23:59:59Z"},"updatedDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case update date","example":"2023-01-01T00:00:00Z"},"updatedDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case update date","example":"2023-12-31T23:59:59Z"},"agentFirstName":{"type":"string","description":"First name of the agent","example":"Jane"},"agentLastName":{"type":"string","description":"Last name of the agent","example":"Smith"},"agentSsn":{"type":"string","description":"Social Security Number of agent"},"brokerDealerName":{"type":"string","description":"Name of the broker-dealer","example":"ABC Financial Services"},"caseIds":{"description":"List of case IDs to search for","example":["CASE123","CASE456"],"type":"array","items":{"type":"string"}},"sortBy":{"type":"string","description":"Field to sort results by","example":"createdAt"},"sortDirection":{"type":"string","description":"Direction of sorting (asc or desc)","example":"desc","enum":["asc","desc"]},"offset":{"type":"string","description":"Offset for pagination","example":"0"},"limit":{"type":"string","description":"Limit for pagination - number of results to return","example":"25"},"notInCaseStatus":{"description":"List of case statuses to exclude from results","type":"array","items":{"type":"string"}},"isIncludeSecondary":{"type":"boolean","description":"Whether to include secondary cases","example":true},"primary":{"type":"boolean","description":"Flag to filter for primary cases only","example":true},"exceptions":{"description":"List of exceptions to search for","type":"array","items":{"$ref":"#/components/schemas/InstanceExceptionModel"}},"identifiers":{"description":"List of identifiers to search for","type":"array","items":{"$ref":"#/components/schemas/IdentifierDocument"}},"issueStatus":{"description":"List of exception statuses to search for","type":"array","items":{"type":"string"}},"escalated":{"type":"boolean","description":"Flag to filter for escalated cases only","example":true},"caseGroups":{"description":"List of case groups to search for","type":"array","items":{"type":"string"}},"groupBy":{"type":"array","description":"List of fields to group by","example":["caseStatus"],"items":{"type":"string","enum":["policyNumber","ssn","ownerName","process","carrier","caseStatus","applicationType"]}}},"required":["groupBy"]},"CaseCount":{"type":"object","properties":{"label":{"type":"string","description":"Label of the grouped value","example":"IN_PROGRESS"},"value":{"type":"number","description":"Count for the grouped label","example":12}}},"CaseStats":{"type":"object","properties":{"attribute":{"type":"string","description":"Grouping attribute name","example":"caseStatus"},"counts":{"description":"Counts by label for the attribute","type":"array","items":{"$ref":"#/components/schemas/CaseCount"}}}},"CaseStatsResponseModel":{"type":"object","properties":{"count":{"type":"number","description":"Total count of matching cases","example":100},"stats":{"description":"Grouped case statistics","type":"array","items":{"$ref":"#/components/schemas/CaseStats"}}}},"SearchFiltersRequestModel":{"type":"object","properties":{"applicationType":{"type":"string","description":"Type of application"},"policyNumber":{"type":"string","description":"Policy number to search for","example":"POL123456789"},"requestSubType":{"description":"List of request sub-types to filter by","type":"array","items":{"type":"string"}},"productName":{"description":"List of product names to filter by","type":"array","items":{"type":"string"}},"ssn":{"type":"string","description":"Social Security Number of policy owner"},"ownerName":{"type":"string","description":"Full name of the policy owner","example":"John Doe"},"ownerFirstName":{"type":"string","description":"First name of policy owner","example":"John"},"ownerLastName":{"type":"string","description":"Last name of policy owner","example":"Doe"},"process":{"description":"List of processes to filter by","type":"array","items":{"type":"string"}},"carrier":{"description":"List of carriers to filter by","example":["EVGL"],"type":"array","items":{"type":"string"}},"caseStatus":{"description":"List of case statuses to filter by","type":"array","items":{"type":"string"}},"createdDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case creation date","example":"2023-01-01T00:00:00Z"},"createdDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case creation date","example":"2023-12-31T23:59:59Z"},"updatedDateStart":{"format":"date-time","type":"string","description":"Start date for filtering by case update date","example":"2023-01-01T00:00:00Z"},"updatedDateEnd":{"format":"date-time","type":"string","description":"End date for filtering by case update date","example":"2023-12-31T23:59:59Z"},"agentFirstName":{"type":"string","description":"First name of the agent","example":"Jane"},"agentLastName":{"type":"string","description":"Last name of the agent","example":"Smith"},"agentSsn":{"type":"string","description":"Social Security Number of agent"},"brokerDealerName":{"type":"string","description":"Name of the broker-dealer","example":"ABC Financial Services"},"caseIds":{"description":"List of case IDs to search for","example":["CASE123","CASE456"],"type":"array","items":{"type":"string"}},"notInCaseStatus":{"description":"List of case statuses to exclude from results","type":"array","items":{"type":"string"}},"isIncludeSecondary":{"type":"boolean","description":"Whether to include secondary cases","example":true},"primary":{"type":"boolean","description":"Flag to filter for primary cases only","example":true},"exceptions":{"description":"List of exceptions to search for","type":"array","items":{"$ref":"#/components/schemas/InstanceExceptionModel"}},"identifiers":{"description":"List of identifiers to search for","type":"array","items":{"$ref":"#/components/schemas/IdentifierDocument"}},"issueStatus":{"description":"List of exception statuses to search for","type":"array","items":{"type":"string"}},"escalated":{"type":"boolean","description":"Flag to filter for escalated cases only","example":true},"caseGroups":{"description":"List of case groups to search for","type":"array","items":{"type":"string"}}}},"CarrierFilterModel":{"type":"object","properties":{"name":{"type":"string","description":"Carrier Code","example":"EVGL"},"products":{"description":"Products available under this carrier","type":"array","items":{"type":"string"}}},"required":["name","products"]},"CaseTypeFilterModel":{"type":"object","properties":{"name":{"type":"string","description":"Case type name","example":"New Business"},"caseSubTypes":{"description":"Case sub-types available under this case type","type":"array","items":{"type":"string"}}},"required":["name","caseSubTypes"]},"SearchFiltersResponseModel":{"type":"object","properties":{"carriers":{"description":"Authorized carrier codes, each with its nested products","type":"array","items":{"$ref":"#/components/schemas/CarrierFilterModel"}},"caseTypes":{"description":"Authorized case types, each with its nested case sub-types","type":"array","items":{"$ref":"#/components/schemas/CaseTypeFilterModel"}},"caseGroups":{"description":"Authorized case groups","type":"array","items":{"type":"string"}}},"required":["carriers","caseTypes","caseGroups"]},"Url":{"type":"object","properties":{"website":{"type":"string","description":"Carrier or Third party administrator website","example":"https://zinnialive.com/"},"carrierLogin":{"type":"string","description":"Carrier login","example":"https://zinnialive.com/"},"agentLogin":{"type":"string","description":"Agent login","example":"https://zinnialive.com/"},"customerLogin":{"type":"string","description":"Customer login","example":"https://wellabe.mypolicyview.com/"}}},"EntityType":{"type":"string","enum":["SOLEPROPRIETORSHIP","GENERALPARTNERSHIP","LIMITEDPARTNERSHIP","CCORPORATION","SCORPORATION","LIMITEDLIABILITYCOMPANY","CHARITABLEORGANIZATION","ESTATE","TRUST","CORPORATION","UNKNOWN"]},"CommunicationType":{"type":"string","enum":["EMAIL","REGULARMAIL","PHONE","FAX","TEXT","NOPREFERENCESPECIFIED","POSTAL","OTHER"]},"FormerOrganizationName":{"type":"object","properties":{"name":{"type":"string","description":"Former legal name of the Organization","example":"Karen Anne Bates"},"abbreviatedName":{"type":"string","description":"The former shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"doingBusinessAs":{"type":"string","description":"The former name the organization is commonly known as","example":"TBD"}}},"Identification":{"type":"object","properties":{"identificationId":{"type":"string","description":"A unique system-generated ID for tracking individual identifier records","example":"1"},"startDate":{"type":"string","description":"The date from which the party`s identifier is considered valid. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"The date after which the party`s identifier is no longer valid. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"identificationType":{"type":"string","enum":["PASSPORT","STATEPHOTOID","DRIVERLICENSENUMBER","SSN","TIN","EXTERNAL","EIN","NATIONALPRODUCERNUMBER","OTHER"],"description":"Specifies the kind of identifier provided for a party. It describes what type of document or number is being used to recognize or verify the party's identity","nullable":true},"identificationKey":{"type":"string","example":"666-50-8548","description":"A unique code (such as ECN, Life Party ID, or Series Code) used to uniquely identify and manage individuals, entities, or product groupings within life insurance and annuity systems"},"identificationValue":{"type":"string","example":"666-50-8548","description":"The unique number of the selected identification type","nullable":true},"identificationDescription":{"type":"string","example":"Employee Control Number","description":"A brief description of the identifier."},"issueState":{"type":"string","enum":["AA","AE","AL","AP","AK","AZ","AR","AS","CA","CO","CT","DC","DE","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MP","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UM","UT","VT","VA","VI","WA","WV","WI","WY"],"nullable":true},"issueCountry":{"type":"string","enum":["US","CA","RU","EG","ZA","GR","NL","BE","FR","ES","HU","IT","RO","CH","AT","GB","DK","SE","NO","PL","DE","PE","MX","CU","AR","BR","CL","CO","VE","MY","AU","ID","PH","NZ","SG","TH","JP","VN","CN","TR","IN","PK","AF","LK","IR","MA","DZ","TN","LY","GM","SN","MR","ML","GN","BF","NE","TG","BJ","MU","LR","SL","GH","NG","CF","TD","CM","CV","ST","GQ","GA","BS","AO","BB","AX","SD","RW","ET","SO","DJ","KE","TZ","UG","BI","MZ","ZM","MG","RE","ZW","NA","MW","LS","BW","AG","KM","GW","CD","VG","SH","AW","FO","GL","KY","GI","PT","LU","IE","IS","AL","MT","CY","FI","BG","GG","LT","LV","EE","MD","AM","BY","AD","SM","UA","HR","SI","BA","MK","XK","CZ","SK","LI","BM","GD","FK","BZ","GT","SV","HN","NI","CR","PM","HT","PR","VI","GS","SX","BQ","GP","BO","GY","EC","GF","PY","MQ","SR","UY","AN","TC","BL","MF","MS","GU","AQ","BN","NR","PG","TO","SB","VU","FJ","WF","CK","NU","AS","KI","NC","TV","PF","MP","PW","MH","FM","SS","LC","DM","VC","DO","HK","MO","KH","LA","TT","KN","JM","BD","TW","MM","KR","KP","LB","JO","SY","IQ","KW","SA","OM","AE","IL","BH","QA","BT","NP","TJ","TM","AZ","GE","UZ","AI","PA","CI","ER","KZ","KG","CC","MN","BV","SC","IO","WS","TL","TF","YT","PN","SJ","TK","UM","EH","MV","CX","NF","CG","MC","VA","SZ","PS","JE","IM","RS","ME","HM","CW","CS","YE","YD","SU","YU","ZR"],"nullable":true}}},"AddressType":{"type":"string","enum":["RESIDENCE","BUSINESS","POBOX","SEASONAL","SECONDARY","MAILING"]},"State":{"type":"string","enum":["AA","AE","AL","AP","AK","AZ","AR","AS","CA","CO","CT","DC","DE","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MP","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UM","UT","VT","VA","VI","WA","WV","WI","WY"]},"Country":{"type":"string","enum":["US","CA","RU","EG","ZA","GR","NL","BE","FR","ES","HU","IT","RO","CH","AT","GB","DK","SE","NO","PL","DE","PE","MX","CU","AR","BR","CL","CO","VE","MY","AU","ID","PH","NZ","SG","TH","JP","VN","CN","TR","IN","PK","AF","LK","IR","MA","DZ","TN","LY","GM","SN","MR","ML","GN","BF","NE","TG","BJ","MU","LR","SL","GH","NG","CF","TD","CM","CV","ST","GQ","GA","BS","AO","BB","AX","SD","RW","ET","SO","DJ","KE","TZ","UG","BI","MZ","ZM","MG","RE","ZW","NA","MW","LS","BW","AG","KM","GW","CD","VG","SH","AW","FO","GL","KY","GI","PT","LU","IE","IS","AL","MT","CY","FI","BG","GG","LT","LV","EE","MD","AM","BY","AD","SM","UA","HR","SI","BA","MK","XK","CZ","SK","LI","BM","GD","FK","BZ","GT","SV","HN","NI","CR","PM","HT","PR","VI","GS","SX","BQ","GP","BO","GY","EC","GF","PY","MQ","SR","UY","AN","TC","BL","MF","MS","GU","AQ","BN","NR","PG","TO","SB","VU","FJ","WF","CK","NU","AS","KI","NC","TV","PF","MP","PW","MH","FM","SS","LC","DM","VC","DO","HK","MO","KH","LA","TT","KN","JM","BD","TW","MM","KR","KP","LB","JO","SY","IQ","KW","SA","OM","AE","IL","BH","QA","BT","NP","TJ","TM","AZ","GE","UZ","AI","PA","CI","ER","KZ","KG","CC","MN","BV","SC","IO","WS","TL","TF","YT","PN","SJ","TK","UM","EH","MV","CX","NF","CG","MC","VA","SZ","PS","JE","IM","RS","ME","HM","CW","CS","YE","YD","SU","YU","ZR"]},"Address":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of the party address. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"endDate":{"type":"string","description":"The end date of the party address. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"addressType":{"$ref":"#/components/schemas/AddressType"},"addressLine1":{"type":"string","description":"Address Line 1 of the party address","example":"1112 Pickle Street"},"addressLine2":{"type":"string","description":"Address Line 2 of the party address","example":"South Jersey"},"addressLine3":{"type":"string","description":"Address Line 3 of the party address","example":"1234 Post box"},"city":{"type":"string","description":"City of the party address","example":"Garden City"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","description":"Zip code of the party address","example":"67846"},"zipCodeExtension":{"type":"string","description":"Unit of the party address","example":"23"},"country":{"$ref":"#/components/schemas/Country"},"isPreferred":{"type":"boolean","description":"TBD"},"addressId":{"type":"string","description":"The record Id stored internally in zahara for each address","example":"1"},"preferredAddress":{"type":"boolean","description":"TBD","example":false}}},"PhoneType":{"type":"string","enum":["MOBILE","HOME","BUSINESS","CLAIMCENTER","CUSTOMERSERVICE","CORPORATEOFFICE","FAX","UNKNOWN","OTHER"]},"Phone":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of when the party can be reached via the phone.Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"The end date of when the party can be reached via the phone. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"phoneType":{"$ref":"#/components/schemas/PhoneType"},"countryCode":{"type":"string","description":"Country Code of the phone","example":"9"},"areaCode":{"type":"string","description":"Area code of the phone","example":"973"},"dialNumber":{"type":"string","description":"Dial number of the phone","example":"765789"},"extension":{"type":"string","description":"Dial in Extension for phone","example":"null"},"bestTime":{"type":"string","description":"The best time to contact the party via phone","example":"null"},"timezone":{"type":"string","description":"Timezone for the entered phone details","example":"null"},"isPreferred":{"type":"boolean","description":"The Preferred Phone Indicator is a boolean flag or attribute assigned to each phone number associated with a party, used to identify which phone number should be used as the primary contact number for communication"},"phoneId":{"type":"string","description":"The record Id stored internally in zahara for each phone","example":"1"}}},"EmailType":{"type":"string","enum":["PERSONAL","BUSINESS","CUSTOMERSERVICE","OTHER"]},"Email":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of when the party can be reached via email.Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"The end date of when the party can be reached via email. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"emailType":{"$ref":"#/components/schemas/EmailType"},"emailAddress":{"type":"string","description":"Email address of the party","example":"user@example.com"},"isPreferred":{"type":"boolean","description":"The Preferred Email Indicator is a boolean flag associated with each email address linked to a party, used to designate which email address should be treated as the primary contact for electronic communications"},"emailId":{"type":"string","description":"The record Id stored internally in zahara for each email","example":"1"}}},"BusinessSchedule":{"type":"object","properties":{"businessHourStart":{"type":"string","format":"time","example":"14:00:00Z","description":"Business Hour Start refers to the official start time of daily business operations for a specific organization, carrier, or department. In insurance and annuity systems, this value is often used to define operational cutoffs, processing schedules, customer service availability, and automated job executions"},"businessHourEnd":{"type":"string","format":"time","description":"Business Hour End refers to the official end time of daily business operations for a specific organization, carrier, or department. It defines the cutoff point for processing transactions, handling customer service requests, and running operational workflows on a given business day","example":"20:00:00Z"},"businessDays":{"type":"array","description":"Business Days refer to the official working days of the week during which business operations, transaction processing, and customer services are conducted. In insurance and annuity systems, business days determine when policies are processed, disbursements are executed, and service-level agreements (SLAs) are measured","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]}},"budgetCenter":{"type":"string","description":"Budget Center refers to a defined organizational unit within a company that is allocated a portion of the company’s overall budget and is responsible for tracking, managing, and controlling financial expenditures. In the context of insurance and annuity operations, a budget center is often linked to departments such as underwriting, claims, operations, or IT","example":"Everglades"}}},"AccountStatus":{"type":"string","enum":["ACTIVEBANKACCOUNT","TERMINATEDBANKACCOUNT"]},"AccountType":{"type":"string","enum":["CHECKING","SAVINGS","CREDITCARD","DEBITCARD","BROKERAGEACCOUNT","CERTIFICATEOFDEPOSIT","WIRE"]},"BankAccountPurpose":{"type":"string","enum":["LOANINTERESTBILLING","DISBURSEMENTS","LOANPRINCIPALBILLING","PREMIUMBILLING","ONETIMEPREMIUMBILLING","PAYOUT","ONETIMEWIRE"]},"BranchAddress":{"type":"object","properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"addressLine1":{"type":"string","example":"1112 Pickle Street","description":"Address line 1 of the Bank"},"addressLine2":{"type":"string","example":"South Jersey","description":"Address line 2 of the Bank"},"addressLine3":{"type":"string","example":"1234 Post box","description":"Address Line 3 of the bank"},"city":{"type":"string","example":"Garden City","description":"City of the bank address"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","example":"67846","description":"Zip code of the bank address"},"zipCodeExtension":{"type":"string","example":"23","description":"Unit of the bank address"},"country":{"$ref":"#/components/schemas/Country"}}},"BankAccount":{"type":"object","properties":{"startDate":{"type":"string","description":"Date the Bank Account of the Party was added to the Policy. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"Date the Bank Account of the Party was terminated from the Policy. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"nameOnAccount":{"type":"string","description":"Name of the Party on Bank Account","example":"abcdqwe"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"accountType":{"$ref":"#/components/schemas/AccountType"},"bankAccountPurpose":{"$ref":"#/components/schemas/BankAccountPurpose"},"accountNumber":{"type":"string","description":"The 7+ digit checking or savings account number","example":"34567777745678"},"routingNumber":{"type":"string","description":"The 9-digit routing transit number for the bank account/branch","example":"123456789"},"internationalBankAccountNumber":{"type":"string","description":"The bank account number for an international bank account (this field does not have check-digit validation)","example":"ibanNumber_66"},"branchName":{"type":"string","description":"The name of the bank (such as Chase Manhattan)","example":"branch_66"},"branchPhoneNumber":{"type":"string","description":"Phone Number of the Bank Branch","example":"7766667777"},"branchAddress":{"$ref":"#/components/schemas/BranchAddress"},"bankId":{"type":"string","description":"In the context of ACORD standards (the global data standards body for insurance), Bank ID refers to a unique identifier used to specify a financial institution involved in a disbursement, premium collection, or electronic funds transfer (EFT). It is critical for ensuring correct routing of payments or deposits between insurers, policyholders, beneficiaries, and third parties","example":"1"},"appliesToPartyId":{"type":"string","example":"Party_PI_1","description":"This unique id ties to the Party Role that the bank details correspondes to."}}},"Carrier":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2023-01-01T12:00:00.000Z"},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"ffae327c5ba748259fe426dd1bad5e9f"},"partyType":{"type":"string","description":"Defines Party type example individual or Organization or Trust. For Insured and Annuitant this should always be Individual","example":"Organization"},"url":{"$ref":"#/components/schemas/Url"},"name":{"type":"string","description":"The legal name of the Organization","example":"Everglades Insurance Company"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"Everglades Life"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization's name that is unique to the organization","example":"EVGL"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"110"},"entityType":{"$ref":"#/components/schemas/EntityType"},"preferredCommunicationType":{"$ref":"#/components/schemas/CommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"formerName":{"$ref":"#/components/schemas/FormerOrganizationName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"carrierId":{"type":"string","description":"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":"EVGL"},"parentCompanyId":{"type":"string","description":"Ultimate Parent Company ID refers to the unique identifier assigned to the top-most legal entity or corporate parent in an organizational hierarchy. In insurance and annuity systems, this ID is used to link a subsidiary, affiliate, or operational entity to its controlling parent company, ensuring clarity in ownership, regulatory reporting, and financial consolidation","example":"EVGLBP"},"organizationPurposeSystemOfRecord":{"type":"string","description":"In the context of a System of Record (SOR) in insurance and annuity systems, Organization Purpose refers to the role the organization plays in relation to the policy or contract. Specifically, terms like Processing and Holding define how the organization interacts with the policy data, assets, or transactions","example":"PROCESSING"},"generalAccountBusinessUnit":{"type":"string","description":"General Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing assets and liabilities held in the general account. This unit is accountable for all financial activities related to non-segregated (non-variable) insurance products where the carrier assumes investment risk","example":"158"},"separateAccountBusinessUnit":{"type":"string","description":"Separate Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing products and assets that are legally segregated from the general account. This unit specifically handles variable or investment-linked products, where the policyholder assumes the investment risk, and assets are maintained in separate investment pools","example":"TBD"},"setId":{"type":"string","description":"Carrier SET ID refers to a unique identifier used within insurance systems to represent a specific insurance carrier`s data set across policy administration, disbursement, and accounting platforms. It groups together all configuration, accounting rules, product definitions, and ledger mappings that apply to a particular carrier or legal entity","example":"EVGLCOC"},"bankCompanyId":{"type":"string","description":"Bank Company ID is a unique identifier assigned to an insurance company or business entity by its bank for electronic funds transfers (EFT), such as ACH (Automated Clearing House) transactions. It is used primarily to identify the originator of payments in financial networks and helps receiving banks verify the legitimacy of transactions","example":"3480409770"},"accountsPayableBusinessUnit":{"type":"string","description":"AP Business Unit (Accounts Payable Business Unit) refers to the distinct organizational or legal entity within an insurance company responsible for processing, approving, and recording outgoing payments, such as claims, policy loans, commissions, refunds, or vendor invoices","example":"Everglades"},"businessSchedule":{"$ref":"#/components/schemas/BusinessSchedule"},"emailSendingDomain":{"type":"string","description":"The domain used for sending emails on behalf of the carrier","example":"example.com"},"depositoryAccount":{"$ref":"#/components/schemas/BankAccount"},"depositoryAccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"controlledDisbursementAccount":{"$ref":"#/components/schemas/BankAccount"},"controlledDisbursementAccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"carrierCode":{"type":"string","description":"TBD"},"version":{"type":"integer","format":"int32"}}},"ErrorResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2023-01-01T12:00:00.000Z"},"message":{"type":"string"}}},"Metadata":{"type":"object","properties":{"isTobaccoUse":{"type":"boolean","description":"Indicates the tobacco usage status, used to differentiate mappings for risk classes that depend on smoking status. (i.e if smoker or non-smoker)"}}},"TranslationBase":{"type":"object","properties":{"systemOfRecordValue":{"type":"string","description":"The value from the Source of Record (e.g., Zahara) that needs to be translated to the corresponding carrier value"},"carrierValue":{"type":"string","description":"The equivalent value used by the carrier system that corresponds to the given sorValue"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"TranslationCategory":{"type":"object","properties":{"categoryName":{"type":"string","enum":["RISKCLASS","TABLERATING","COVERAGEBAND","PAYMENTMETHOD","TRANSACTION","FEATURE"],"description":"The group or classification of values for which translation is being requested"},"translations":{"type":"array","items":{"$ref":"#/components/schemas/TranslationBase"}}}},"Translations":{"type":"object","properties":{"carrierId":{"type":"string","description":"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"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/TranslationCategory"}}}},"ThirdPartyAdministrator":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2023-01-01T12:00:00.000Z"},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"ffae327c5ba748259fe426dd1bad5e9f"},"customerId":{"type":"string","description":"Assigned by Sales Force and used by all platforms","example":"TBD"},"partyType":{"type":"string","description":"Defines Party type example individual or Organization or Trust. For Insured and Annuitant this should always be Individual","example":"Organization"},"url":{"$ref":"#/components/schemas/Url"},"name":{"type":"string","description":"TBD","example":"Zinnia"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"EVGL"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"12345678"},"entityType":{"$ref":"#/components/schemas/EntityType"},"preferredCommunicationType":{"$ref":"#/components/schemas/CommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"formerName":{"$ref":"#/components/schemas/FormerOrganizationName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"organizationPurposeSystemOfRecord":{"type":"string","description":"In the context of a System of Record (SOR) in insurance and annuity systems, Organization Purpose refers to the role the organization plays in relation to the policy or contract. Specifically, terms like Processing and Holding define how the organization interacts with the policy data, assets, or transactions","example":"PROCESSING"},"generalAccountBusinessUnit":{"type":"string","description":"General Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing assets and liabilities held in the general account. This unit is accountable for all financial activities related to non-segregated (non-variable) insurance products where the carrier assumes investment risk","example":"TBD"},"separateAccountBusinessUnit":{"type":"string","description":"Separate Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing products and assets that are legally segregated from the general account. This unit specifically handles variable or investment-linked products, where the policyholder assumes the investment risk, and assets are maintained in separate investment pools","example":"TBD"},"version":{"type":"integer","description":"TBD","format":"int32"}}},"ChartOfAccount":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2023-01-01T12:00:00.000Z"},"carrierId":{"type":"string","description":"Carrier Code is a unique identifier assigned to each insurance carrier (insurance company) within a system, typically used to distinguish between multiple carriers in a multi-carrier environment. It is essential for chart of account setup, policy administration, and reporting across insurance platforms","example":"EVGL"},"carrierSetId":{"type":"string","description":"Carrier SET ID refers to a system-specific grouping identifier that represents a set of data, configuration, or financial parameters uniquely tied to a particular carrier within the chart of accounts and policy administration system","example":"EVGLCOC"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"The Qualification Type in life insurance and annuities refers to the tax law provision or regulatory classification that governs a policy or contract, indicating whether it falls under a tax-advantaged retirement plan (IRA, 401(k), 403(b)) or a non-qualified account"},"accountNumber":{"type":"string","description":"Account Number refers to a unique numeric or alphanumeric identifier assigned to a general ledger account within the chart of accounts for an insurance carrier. It is used to classify and record financial transactions such as premiums, claims, commissions, reserves, or administrative expenses","example":"299032"},"account":{"type":"string","enum":["GENERAL"],"description":"In the context of an insurance Chart of Accounts, Account refers to the classification of financial activity as it relates to either a General Account or a Separate Account. This designation helps insurers manage and report assets and liabilities according to their investment and ownership structure"},"generalLedgerAccount":{"type":"string","description":"A General Ledger (GL) Account is a system-defined record that captures and categorizes financial transactions within an insurer`s accounting framework. It is a fundamental component of the Chart of Accounts, used to organize and report assets, liabilities, income, and expenses associated with life and annuity products, policyholder transactions, and operational activities","example":"GL531100"},"generalLedgerAccountShortName":{"type":"string","description":"GL Short Name refers to a concise, system-friendly label assigned to a General Ledger (GL) account for ease of reference, display, and reporting in financial systems. It provides a brief but meaningful identifier for the full GL account name, especially in user interfaces, dashboards, and exports where space is limited","example":"TBD"},"accountType":{"type":"string","enum":["ASSET","LIABILITY","INCOME","BENEFIT"],"description":"Account Type refers to the category that classifies a general ledger (GL) account based on the nature of its financial activity, such as asset, liability, equity, income, or expense. It determines how the account behaves in financial reporting, balance sheets, and income statements, and is critical for structuring the chart of accounts in insurance and annuity accounting systems"},"accountTypeCode":{"type":"string","enum":["A","L","I","B"],"description":"Account Type Code is a system-assigned or standardized alphanumeric identifier used to represent the classification of a general ledger (GL) account by its financial nature—such as Asset, Liability, Equity, Income, or Expense—in a structured and codified format. It is used in chart of account setups for reporting, system logic, and integration"},"version":{"type":"integer","format":"int32"}}},"Account":{"type":"string","enum":["GENERAL"]},"ChartOfAccountRequestFields":{"type":"object","properties":{"carrierId":{"type":"string","description":"Carrier Code","example":"EVGL"},"carrierSetId":{"type":"string","description":"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":"EVGLCOC"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"Qualification type of original policy being exchanged"},"accountNumber":{"type":"string","description":"GL Account Number","example":"299032"},"account":{"$ref":"#/components/schemas/Account"},"generalLedgerAccount":{"type":"string","description":"Account numbers used to categorize types of financial transactions","example":"GL531100"},"generalLedgerAccountShortName":{"type":"string","description":"Account numbers used to categorize types of financial transactions","example":"TBD"},"accountType":{"type":"string","enum":["ASSET","LIABILITY","INCOME","BENEFIT"],"description":"Account Type refers to the category that classifies a general ledger (GL) account based on the nature of its financial activity, such as asset, liability, equity, income, or expense. It determines how the account behaves in financial reporting, balance sheets, and income statements, and is critical for structuring the chart of accounts in insurance and annuity accounting systems"},"accountTypeCode":{"type":"string","enum":["A","L","I","B"],"description":"Account Type Code is a system-assigned or standardized alphanumeric identifier used to represent the classification of a general ledger (GL) account by its financial nature—such as Asset, Liability,Equity, Income, or Expense—in a structured and codified format. It is used in chart of account setups for reporting, system logic, and integration"}}},"ProductType":{"type":"string","enum":["WHOLELIFE","UNIVERSALLIFE","VARIABLEUNIVERSALLIFE","VARIABLEWHOLELIFE","INDEXEDUNIVERSALLIFE","FIXEDANNUITY","FIXEDINDEXEDANNUITY","TERM","TERMWITHCASHVALUE"]},"Rules":{"type":"object","properties":{"variable":{"type":"string"},"entityType":{"type":"string"},"debitAccount":{"type":"string"},"creditAccount":{"type":"string"},"ledgerType":{"type":"string"}}},"AccountingEntryRules":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the rule","example":"65a867a326d49513ae85c2d3"},"timestamp":{"type":"string","description":"The timestamp of the rule","example":"2023-01-01T12:00:00.000Z"},"productType":{"$ref":"#/components/schemas/ProductType"},"transactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc"},"rules":{"description":"The rules for the entry","type":"array","items":{"$ref":"#/components/schemas/Rules"}},"carrierId":{"type":"string","description":"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":"EVGL"},"carrierSetId":{"type":"string","description":"The carrier set ID","example":"EVGLCOC"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"qualificationType":{"type":"string","description":"Qualification type of original policy being exchanged","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"]},"version":{"type":"integer","description":"The version","example":1,"format":"int32"}}},"AccountEntryRuleRequestFields":{"type":"object","properties":{"productType":{"$ref":"#/components/schemas/ProductType"},"transactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/Rules"}}}},"DistributionCode":{"type":"string","enum":["DEFAULT","PREMATUREDISTRIBUTION","EXCEPTIONAPPLIES","DISABILITY","DEATH","DEATHEXCLUSION","DEATHROLLOVER","EXCHANGE1035","NORMALDISTRIBUTION","COSTOFCURRENTLIFEINSURANCEPROTECTION","QUALIFIEDROLLOVER","ROTHDISTRIBUTIONNOEXCEPTION","QUALIFIEDLOANDISTRIBUTION","PREMATURELOANDISTRIBUTION","QUALIFIEDROTHINDIVIDUALRETIREMENTARRANGEMENTDISTRIBUTION","ROTHINDIVIDUALRETIREMENTACCOUNTSDISTRIBUTIONEXCEPTIONAPPLIES","EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSTAXABLEIN2009","NONTAXABLEEVENT","GROSSPAIDTOATTORNEY","OTHERINCOME","NONEMPLOYEECOMPENSATION","PREMATUREEXCEPTION","ROYALTIES","DEATHTRANSFER4H","PROHIBITEDTRANSACTION","TENYEARTAXOPTION","TRUSTEETOTRUSTEETRANSFER","QUALIFIEDDOMESTICRELATIONSORDERLIKETOLIKENO1099","DISTRIBUTIONSUNDEREMPLOYEEPLANSCOMPLIANCERESOLUTIONSYSTEM","CHARITABLEGIFT","LOANSASDISTRIBUTIONS","QUALIFIEDPLANLOANOFFSET","RECHARACTERIZEDINDIVIDUALRETIREMENTARRANGEMENTCURRENTYEAR","EXCESSCONTRIBUTION1YEARPRIORTAX","RECHARACTERIZEDINDIVIDUALRETIREMENTACCOUNTSPREVIOUSYEAR","EARLYDISTRIBUTIONFROMSAVINGSINCENTIVEMATCHPLANFOREMPLOYEES","DIRECTTRANSFER","EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSANDOREARNINGSTAXABLEIN2024","EXCESSCONTRIBUTIONS2YEARPRIORTAX","DIRECTROLLOVERQUALPLANTAXSHELTEREDANNUITY","SEPARATIONFROMSERVICE","INDIVIDUALRETIREMENTARRANGEMENTTOROTHINDIVIDUALRETIREMENTARRANGEMENT","QUALIFIEDDOMESTICRELATIONSORDERROLLOVERTOINDIVIDUALRETIREMENTARRANGEMENT2G","QUALIFIEDDOMESTICRELATIONSORDERPAYMENTTOSPOUSE","FIRSTTIMEHOMEBUYERINDIVIDUALRETIREMENTARRANGEMENTONLY","EDUCATIONEXPENSE","MEDICALEXPENSE","FEEADMIN","FEEASSET","FEECONTRIBUTION","FEELUMPSUMDEATH","FEELUMPSUMDISABILITY","FEELUMPSUMPURCHASEDANNUITY","FEELUMPSUMOTHER","FEENEWRETIREEWITHPERPAYMENT","FEEEXISTINGRETIREMENTINFORCE","FEECONTRACT","FEEEXISTINGRETIREMENTINCREASE","FEETHIRDPARTY","LUMPSUMDEATH","LUMPSUMDISABILITY","LUMPSUMPURCHASEDANNUITY","LUMPSUMOTHER","FEEINTERNATIONALPROGRAMSGROUPEXPENSE","FROMFUND","RELEASERESERVE","HEALTHDEDUCTION","FEEMARKETVALUE","FEEANNUITYADMINISTRATION","SECTION1035EXCHANGEPARTIAL","QUALIFIEDDOMESTICRELATIONSORDERNORMALDISTRIBUTION","QUALIFIEDDOMESTICRELATIONSORDERSECTION1035","FEELONGTERMCAREINSURANCE","DESIGNATEDROTHACCOUNTDISTRIBUTION","REPORTABLEDEATHBENEFITSUNDERSECTION6050Y","DISTRIBUTIONOFTRADITIONALINDIVIDUALRETIREMENTARRANGEMENTASSETSNOTHAVINGAREADILYAVAILABLEFAIRMARKETVALUE","DIVIDENDSDISTRIBUTEDFROMANEMPLOYEESTOCKOWNERSHIPPLANSUNDERSECTION404K","DIRECTROLLOVEROFADESIGNATEDROTHACCOUNT","DEATHQUALIFIEDCHARITABLEDISTRIBUTION","NORMALQUALIFIEDCHARITABLEDISTRIBUTION"]},"Disbursement":{"type":"object","properties":{"id":{"type":"string","description":"Disbursement ID refers to the unique identifier assigned to a specific disbursement transaction within an insurance or annuity system. It is used to track, reference, and audit the payout or withdrawal of funds related to a policy, such as benefit payments, loans, withdrawals, or refunds","example":"65a867a326d49513ae85c2d3"},"correlationId":{"type":"string","description":"The unique ID to track each transaction request across all systems","example":"657b717b7dcf554abf9ef067"},"source":{"type":"string","description":"Source System refers to the originating system or platform from which a financial transaction, policy event, or accounting entry is generated and passed into the general ledger or accounting engine. It identifies where the data came from, helping to track, validate, and audit entries across integrated insurance systems","example":"ZHA"},"carrierId":{"type":"string","description":"Carrier Code is a unique identifier assigned to each insurance carrier (insurance company) within a system, typically used to distinguish between multiple carriers in a multi-carrier environment. It is essential for chart of account setup, policy administration, and reporting across insurance platforms","example":"EVGL"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"setId":{"type":"string","description":"Carrier SET ID refers to a system-specific grouping identifier that represents a set of data, configuration, or financial parameters uniquely tied to a particular carrier within the chart of accounts and policy administration system","example":"EVGLCOC"},"businessUnit":{"type":"string","description":"AP Business Unit (Accounts Payable Business Unit) refers to the organizational entity or department responsible for processing and recording disbursements in the general ledger. It represents the source entity within the enterprise`s financial structure that issues payments, such as claims, withdrawals, policy loans, or refunds","example":"11001"},"invoiceDate":{"type":"string","format":"date","description":"Invoice Date refers to the date on which an invoice or payment request is issued or recorded for a disbursement transaction. In the context of insurance and annuity disbursements, this could relate to payments for claims, commissions, policy loans, refunds, or services provided (e.g., third-party administrator fees or vendor invoices)","example":"2024-01-18"},"invoiceId":{"type":"string","description":"Invoice ID is a unique identifier assigned to a disbursement-related invoice, used for tracking, reconciliation, and audit purposes across financial and operational systems in insurance and annuity environments","example":"AK10000015"},"contractNumber":{"type":"string","description":"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":"AK10000015"},"transactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Transaction Type refers to the specific kind of financial activity or event that occurs within a life insurance or annuity policy, and is used to trigger predefined accounting entry rules. It defines what the transaction represents (e.g., premium payment, claim payout, fee deduction), and determines how it should be recorded in the general ledger"},"parentTransactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Parent Transaction Type refers to the original or primary business event that triggers or causes a related disbursement transaction (the “child” transaction). In insurance and annuity systems, it identifies the source action or condition that results in money being disbursed—such as a claim approval, policy loan request, withdrawal, or refund"},"transactionId":{"type":"string","description":"Transaction ID is a unique identifier assigned to each financial or policy-related transaction within an insurance or annuity system. It serves as a reference key to track, audit, and link the transaction across systems—such as policy administration, billing, claims, and general ledger","example":"13"},"arNumber":{"type":"string","description":"AR Number stands for Accounts Receivable Number and refers to the unique identifier assigned to a receivable transaction that reflects money owed to the insurance company. In some insurance systems, it may also be used to track receivable offsets against disbursements, such as refunds, recoveries, or adjustments","example":"Party_PI_1"},"paymentMethod":{"type":"string","description":"The type of payment method such as DTCC,EFT or credit card","example":"EFT"},"netPaymentAmount":{"type":"number","format":"double","description":"The actual dollar amount disbursed to the payee","example":5},"payeeGrossAmount":{"type":"number","description":"TBD","example":20},"distributionInternalRevenueServiceCode":{"type":"string","description":"The IRS tax reporting code associated to the distribution code","example":"LD"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"costBasisChangeAmount":{"type":"number","description":"The Cost Basis Change Amount refers to the difference between the old and new cost basis of a life insurance policy or annuity. It reflects adjustments due to premium payments, withdrawals, policy loans, 1035 exchanges, or other financial transactions that impact the total cost basis","example":161.81698,"format":"double"},"ownerName":{"type":"string","example":"KAREN Anne BATES","description":"Name of the owner"},"annuitantName":{"type":"string","example":"KAREN Anne BATES","description":"Name of the annuitant"},"payeeName":{"type":"string","description":"Name of the payee","example":"Karen Anne Bates"},"payeeAddress":{"$ref":"#/components/schemas/Address"},"bankDetail":{"$ref":"#/components/schemas/BankAccount"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of FFC - For Further Credit (to notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."},"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2024-01-25T17:51:17.312Z"},"originalTransactionId":{"type":"string","description":"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","example":"1"}}},"AccountingEntries":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the entry","example":"65a867a326d49513ae85c2d3"},"timestamp":{"type":"string","description":"The timestamp of the entry","example":"2024-01-17T23:49:55.090Z"},"carrierId":{"type":"string","description":"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":"EVGL"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"policyNumber":{"type":"string","description":"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":"POLICY1234567890"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"The Qualification Type in life insurance and annuities refers to the tax law provision or regulatory classification that governs a policy or contract, indicating whether it falls under a tax-advantaged retirement plan (IRA, 401(k), 403(b)) or a non-qualified account"},"accountEntryType":{"type":"string","description":"Account Entry Type refers to the categorization of a financial entry within an accounting system that indicates the nature or purpose of the entry being recorded. It helps define what the transaction represents and how it should be processed or interpreted in the general ledger","example":"DEBIT"},"accountNumber":{"type":"string","description":"Account Number refers to a unique numeric or alphanumeric identifier assigned to a general ledger account within the chart of accounts for an insurance carrier. It is used to classify and record financial transactions such as premiums, claims, commissions, reserves, or administrative expenses","example":"299032"},"accountPeriod":{"type":"number","description":"Accounting Period refers to the specific span of time during which financial transactions are recorded, summarized, and reported in the accounting system. It is used to group entries within a defined time frame for financial reporting, reconciliation, and audit purposes.","example":1,"format":"int32"},"ledgerType":{"type":"string","description":"Ledger Type refers to the classification of the general ledger (GL) in which a financial transaction is recorded, based on the purpose, scope, or basis of accounting. It determines where and how transactions are captured, reported, and reconciled within an insurance company’s financial systems","example":"ACTUAL"},"ledgerGroup":{"type":"string","description":"Ledger Group refers to a collection of related general ledger (GL) accounts grouped together under a common identifier for financial reporting, accounting rule application, and system processing. In insurance and annuity systems, it helps organize and manage posting logic, financial segmentation, and parallel accounting structures (e.g., statutory, GAAP, tax).","example":"ACTUAL"},"sourceSystem":{"type":"string","description":"Source System refers to the originating system or platform from which a financial transaction, policy event, or accounting entry is generated and passed into the general ledger or accounting engine. It identifies where the data came from, helping to track, validate, and audit entries across integrated insurance systems","example":"ZAH"},"state":{"type":"string","description":"In the context of accounting entries or insurance policy administration, State refers to the U.S. state or jurisdiction associated with a policy, transaction, or party. This field is critical for determining regulatory, tax, and reporting requirements, as insurance is regulated at the state level in the U.S.","example":"TX"},"currency":{"type":"string","description":"Currency refers to the monetary unit in which a financial transaction, policy value, or accounting entry is denominated. In insurance and annuity accounting systems, the Currency field specifies the legal tender used for recording and reporting transactions such as premiums, claims, fees, commissions, and investments","example":"USD"},"amount":{"type":"number","description":"Amount refers to the numerical value of a financial transaction recorded in an accounting entry. In insurance and annuity systems, it represents the monetary value applied to a specific debit or credit line within a journal entry, and is typically expressed in the designated currency of the transaction","example":80},"generalLedgerPlanCode":{"type":"string","description":"GL Product Code refers to a unique identifier used to classify financial transactions in the general ledger (GL) based on the insurance or annuity product type. It links each accounting entry to a specific product line, allowing for accurate reporting, reconciliation, and financial analysis at the product level","example":"V2201"},"fundId":{"type":"string","description":"Fund ID refers to a unique identifier assigned to a specific investment fund or account within an insurance or annuity product structure. It is used to track, allocate, and report financial activity related to investment-linked products, such as variable annuities, variable universal life (VUL), or separate account products","example":"FundAccount1"},"distributionChannel":{"type":"string","description":"Distribution Channel refers to the method or pathway through which insurance and annuity products are marketed, sold, and delivered to customers. In the context of accounting entry rules and policy administration, it helps identify how the business was acquired and may influence commission structures, financial reporting, and accounting treatments","example":"D"},"accountingMethod":{"type":"string","description":"Accounting Method refers to the approach or set of rules used to recognize, record, and report financial transactions in the accounting system. In the context of insurance and annuity accounting entry rules, it determines when and how revenues, expenses, assets, and liabilities are recorded, and is essential for ensuring regulatory compliance and financial accuracy","example":"C"},"transactionDate":{"type":"string","description":"Transaction Date refers to the actual date on which a financial or business event occurred that results in an accounting entry. In insurance and annuity systems, this is the date the transaction (e.g., premium payment, claim payout, commission, fee, or reserve adjustment) was executed or became effective, and it serves as a key reference point for financial reporting and auditing","example":"2024-01-17"},"transactionId":{"type":"string","description":"Transaction ID is a unique identifier assigned to each financial or policy-related transaction within an insurance or annuity system. It serves as a reference key to track, audit, and link the transaction across systems—such as policy administration, billing, claims, and general ledger","example":"15"},"transactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc"},"unit":{"type":"string","description":"Unit refers to the standardized measure used to represent a quantity of insurance coverage, investment participation, or transactional value within an insurance, annuity, or accounting system. It is typically used to calculate coverage amounts, charges, benefits, or allocations based on a per-unit basis","example":"110"}}},"CarrierType":{"type":"string","enum":["SB"]},"Identifier":{"type":"object","properties":{"identifier":{"type":"string","description":"Attribute name storing the policy reference id generated by RDE system","example":"policyReferenceId"},"value":{"type":"string","description":"A unique policy reference id generated by RDE system","example":"54c246a0-d690-43f1-9a94-5ec1bdc5de7c"}}},"Event":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID generated by SOR system for the given event","example":"81887a67-81ea-416f-87e6-db3dff9c60c6"},"correlationid":{"type":"string","description":"The unique ID to track each transaction request across all systems","example":"79d75952-5aae-4430-bb00-97a8f7dbbc4c"},"source":{"type":"string","description":"SOR system name defaults to Zahara","example":"zahara"},"carrier":{"$ref":"#/components/schemas/CarrierType"},"specversion":{"type":"string","description":"Schema version of Event (object)","example":"1"},"type":{"type":"string","example":"policy.anniversary.completed","format":"[Entity].[EventName].[Status]","description":"Type of event represented by combining the different event name and the status Entity - policy EventName - activation - addresschange - anniversary - bankaccountchange - Beneficiarychange - claimpayout - costofinsurance - disbursement - emailchange - expensecharge - faceamountchange - freelookcancellation - freelookexpiration - fullsurrender - paymentInitialPremium - initialpremium - interestcredit - interestcreditloan - interestcreditmatch - interestloan - lapseassessment - loananniversarytrueUp - newloan - ownerchange - partialwithdrawalonetime - payeechange - paymentsystematicloanrepayment - payorchange - phonenumberchange - policydetailschange - policyissuance - preferredmailingaddresschange - subsequentpayment - subsequentpremium - systematicloanrepayment - systematicloanrepaymentsetup - systematicpartialwithdrawal - systematicpartialwithdrawalsetup - tpdchange - unitexpensecharge - paymentonetimepremium - onetimepremium Status - pending - completed - canceled - reversed - failed - pendingreversal"},"datacontenttype":{"type":"string","enum":["application/json","application/xml"],"description":"Defines the content type of data field"},"data":{"type":"string","description":"Event data in one of the formats specified in datacontenttype field","example":"{\"policyNumber\": \"POLICY1234567890\", \"transactionId\" : \"25\", \"status\": \"Completed\",\"version\": \"25\"}"},"time":{"type":"string","description":"Time of event in date time format (UTC)","format":"date-time","example":"2023-11-27T07:40:51.487Z"},"identifiers":{"description":"Identifiers","allOf":[{"$ref":"#/components/schemas/Identifier"}]}}},"ConversionCreateRequest":{"type":"object","properties":{"sourceSystem":{"type":"string","description":"Source System"},"carrier":{"type":"string","description":"Carrier"},"planCode":{"type":"string","description":"Plan Code"},"conversionDate":{"type":"string","description":"Conversion Date","format":"date"},"processDate":{"type":"string","description":"Process Date","format":"date"},"requestorId":{"type":"string","description":"Requestor ID"},"policyNumbers":{"description":"Policy Numbers","type":"array","items":{"type":"string"}}}},"ConversionStatus":{"type":"object","properties":{"id":{"type":"string"},"policyNumber":{"type":"string"},"conversionAsOfDate":{"type":"string","format":"date"},"processDate":{"type":"string","format":"date"},"status":{"type":"string"},"fastExtractStatus":{"type":"string"},"fastExtractStartTime":{"type":"string","format":"date-time"},"fastExtractEndTime":{"type":"string","format":"date-time"},"dataConvertStatus":{"type":"string"},"dataConvertStartTime":{"type":"string","format":"date-time"},"dataConvertEndTime":{"type":"string","format":"date-time"},"ledgerLoadStatus":{"type":"string"},"ledgerLoadStartTime":{"type":"string","format":"date-time"},"ledgerLoadEndTime":{"type":"string","format":"date-time"},"source":{"type":"string"},"startDateTime":{"type":"string","format":"date"},"endDateTime":{"type":"string","format":"date"},"errorMessage":{"type":"string"}}},"CVQValues":{"type":"object","properties":{"valueDate":{"type":"string","format":"date-time"},"isPreviouslyPersisted":{"type":"boolean"},"faceAmount":{"type":"number"},"accountValue":{"type":"number"},"netCashSurrenderValue":{"type":"number"},"matchCumulativePayments":{"type":"number"},"matchCumulativeInterestEarned":{"type":"number"},"matchAccountValue":{"type":"number"},"loanBalance":{"type":"number"},"maxWithdrawalValue":{"type":"number"},"yTDWithdrawal":{"type":"number"},"previouslyPersisted":{"type":"boolean"},"ytdwithdrawal":{"type":"number"}}},"MessageResponse":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer","format":"int32"},"message":{"type":"object"}}},"GetCVQ":{"type":"object","properties":{"cVQValues":{"$ref":"#/components/schemas/CVQValues"},"messageResponse":{"$ref":"#/components/schemas/MessageResponse"},"cvqvalues":{"$ref":"#/components/schemas/CVQValues"}}},"PremiumHistory":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date-time"},"amount":{"type":"number"}}},"DistributionHistory":{"type":"object","properties":{"transactionType":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"amount":{"type":"number","format":"double"}}},"Owner":{"type":"object","properties":{"ownerType":{"type":"string"},"ownerName":{"type":"string"},"ownerAge":{"type":"integer","format":"int32"},"ownerAddressLine1":{"type":"string"},"ownerAddressLine2":{"type":"string"},"ownerAddressLine3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"preferredCommunicationType":{"type":"string"},"email":{"type":"string"}}},"EmploymentStatus":{"type":"string","enum":["ACTIVE","RETIRED","DISABLED","LAIDOFF","LEAVEDUETOCHILDBIRTH","LEAVEDUETOMILITARYSERVICE","LEAVEOFABSENCE","RESIGNED","SHORTTERMDISABILITY","TERMINATED","UNKNOWN","OTHER"]},"CauseOfDeath":{"type":"string","enum":["AIDS","ACCIDENTOTHER","ACCIDENTBYFIRE","ACCIDENTALDROWNING","ACCIDENTALFALL","ACCIDENTALPOISONING","AIRCRAFTACCIDENT","ALCOHOLISM","ALLERGICDISORDERS","ANEMIA","APPENDICITIS","ARTERIALDISEASE","AVITAMINOSIS","BENIGNTUMOR","BIRTHINJURY","BRONCHITIS","BRONCHOPNEUMONIA","COVID","CANCERBONE","CANCERBREAST","CANCERCERVIX","CANCERESOPHAGUS","CANCERINTESTINE","CANCERLARYNX","CANCERLUNG","CANCERMOUTH","CANCEROTHER","CANCERPROSTATE","CANCERRECTUM","CANCERSKIN","CANCERSTOMACH","CANCERUTERUS","CIRCULATORYOTHER","CIRRHOSIS","CONGENITALDISORDER","DIABETES","DIGESTIVEDISEASEOTHER","DIPTHERIA","DRUGOVERDOSE","DYSENTERY","EARINFECTION","EMPHYSEMA","ENCEPHALITIS","ENLARGEDPROSTATE","EPILEPSY","FIREARMACCIDENT","FLU","GALLSTONE","GASTRITIS","GASTROENTERITIS","GOITERNONTOXIC","HEARTARTERIOSCLEROTIC","HEARTOTHER","HEARTRHEUMATIC","HERNIA","HOMICIDE","HYPERTENSIONHEART","HYPERTENSIONNOHEART","KIDNEYINFECTION","KIDNEYSTONE","LEUKAEMIA","LUNGDISEASEOTHER","LYMPHORSARCOMA","MACHINERYACCIDENT","MALARIA","MEASLES","MENINGITISMENIN","MENINGITISNONMENIN","MENTALDISORDER","MOTORVEHICLEACCIDENT","MULTIPLESCLEROSIS","NATURALDEATH","NEPHRITIS","NERVOUSSYSTEMOTHER","NEWBORNDISORDEROTHER","NEWBORNINFECTION","OSTEOMYELITIS","PARASITICDISEASEOTHER","PLEURISY","PNEUMONIALOBAR","PNEUMONIAOTHER","POLIO","PREGNANCYDISORDER","RHEUMATICFEVER","SCARLETFEVER","SENILITY","SEPTICAEMIA","SKINDISEASEOTHER","SKININFECTION","SUICIDE","SYPHILIS","TETANUS","THYROTOXICOSIS","TUBERCULOSIS","TYPHOID","TYPHUS","ULCEROFDUODENUM","ULCEROFSTOMACH","UNKNOWN","URINARYDISEASEOTHER","VASCULARLESIONS","WAR","WHOOPINGCOUGH","PENDINGINVESTIGATION","ACCIDENT"]},"DeathDetail":{"type":"object","properties":{"dateOfDeath":{"type":"string","format":"date","description":"The date on which the insured/annuitant died","example":"2023-01-01"},"causeOfDeath":{"$ref":"#/components/schemas/CauseOfDeath"},"deathNotificationDate":{"type":"string","format":"date","description":"The date on which carrier was notified of the death","example":"2023-01-01"},"dateOfDueProof":{"type":"string","format":"date","description":"Date the appropriate death paperwork was received (example - death certificate receive date)","example":"2023-01-01"}}},"ImpairmentDetails":{"type":"object","properties":{"disabled":{"type":"boolean","description":"Any disability details of the insured"},"disabilityStartDate":{"type":"string","format":"date","description":"The disability start date of the insured","example":"2023-01-01"}}},"Insured":{"type":"object","properties":{"existingLifeInsurance":{"type":"boolean","description":"Any existing life insurance details of the insured"},"existingLifeInsuranceAmount":{"type":"number","format":"double","example":0,"description":"The existing life insurance amount of the insured"},"replaceLifeInsurance":{"type":"boolean","description":"Any life insurance replacement details of the insured"},"pendingOrPlanToBuyAdditional":{"type":"boolean","description":"Any details of pending or plan to buy additional life insurance of the insured"},"isDependent":{"type":"boolean","description":"Any dependent details of the insured"},"employed":{"type":"boolean","description":"Any employment details of the insured"},"employmentStatus":{"$ref":"#/components/schemas/EmploymentStatus"},"occupation":{"type":"string","description":"Occupation of the insured","example":"Salesman"},"householdIncome":{"type":"number","format":"double","description":"Household income of the insured","example":50000},"deathDetails":{"$ref":"#/components/schemas/DeathDetail"},"impairmentDetails":{"$ref":"#/components/schemas/ImpairmentDetails"}}},"DeathBenefitOption":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"FundPortfolioAllocation":{"type":"object","properties":{"fundCode":{"type":"string"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure"},"fundMktName":{"type":"string"},"amount":{"type":"number","format":"double"}}},"Coverage":{"type":"object","properties":{"nARWeighting":{"type":"number","format":"double"},"code":{"type":"string"},"name":{"type":"string"},"guidelineSinglePremium":{"type":"number","description":"The Guideline Single Premium (GSP) refers to the maximum single premium payment that can be made into a life insurance policy without violating the IRSs Guideline Premium Test (GPT). It is used to ensure that the policy qualifies as life insurance and maintains its tax-advantaged status","format":"double"},"guidelineLevelPremium":{"type":"number","description":"The Guideline Level Premium (GLP) is the maximum level (annual or periodic) premium that can be paid into a life insurance policy while maintaining compliance with the IRSs Guideline Premium Test (GPT). It ensures that the policy remains classified as life insurance and retains its tax-advantaged status","format":"double"},"get_7PayPremium":{"type":"number","format":"double"},"issueDate":{"type":"string","description":"The Policy Issue Date, also known as the Policy Launch Date, is the date when the insurance company officially issues the policy to the client. This occurs after the application is approved, the insured accepts the offer, and payment information is provided. It marks the formal activation of the policy and triggers policy delivery","format":"date-time"},"targetPremium":{"type":"number","format":"double"},"targetCommission":{"type":"number","format":"double"},"maturityDate":{"type":"string","description":"The Policy Maturity Date refers to the date when a life insurance policy reaches its maturity or an annuity contract reaches its maximum annuitization age. It is based on the Policy Start Date and determines when benefits become payable or coverage ends","format":"date-time"},"coverageAmount":{"type":"number","format":"double"},"underwritingBasis":{"type":"string"},"originalCoverageAmount":{"type":"number","format":"double"},"coverageChangeAmount":{"type":"number","format":"double"},"coverageTerminationDate":{"type":"string","format":"date-time"},"insured":{"type":"array","items":{"$ref":"#/components/schemas/Insured"}},"narweighting":{"type":"number","format":"double"}}},"RiderType":{"type":"string","enum":["BASE","RIDER","BASEINCREASE","INTEGRATEDRIDER","RIDERINCREASE","BENEFIT","DISCOUNT","OTHER","UNKNOWN"]},"UnderwritingStatus":{"type":"string","enum":["APPROVED","DECLINED"]},"Status":{"type":"string","enum":["ACTIVE","TERMINATED","PENDING","SUSPENDED"]},"RiderParticipant":{"type":"object","properties":{"insuredId":{"type":"string","description":"A unique identifier assigned to the insured individual within the system who was covered under this rider","example":"Party_PI_1"},"insuredAgeAtIssue":{"type":"number","description":"The age of the insured at the time the rider was issued","example":50,"format":"int32"}}},"FlatExtra":{"type":"object","properties":{"flatExtraType":{"type":"string","enum":["TEMPORARY","PERMANENT"],"description":"A Flat Extra is an additional dollar amount added to the base premium for a life insurance policy due to increased risk factors. Insurers apply Flat Extras on top of standard risk classifications (e.g., Preferred, Standard, or Substandard ratings).Flat Extras can be classified into two types \"Temporary Flat Extra\" and \"Permanent Flat Extra\""},"flatExtraDuration":{"type":"number","description":"The Flat Extra Duration refers to the length of time a Flat Extra premium charge is applied to a life insurance policy. This duration depends on whether the Flat Extra is temporary or permanent, and it is determined by the insurer based on the risk factor associated with the insured","format":"int32","example":0},"flatExtraAmount":{"type":"number","description":"The Flat Extra Amount refers to an additional charge per $1,000 of coverage that an insurer applies to a life insurance policy due to an increased risk factor. This extra cost is added on top of the standard premium and can be temporary or permanent, depending on the nature of the risk","format":"double","example":0},"flatExtraStartDate":{"type":"string","description":"The Flat Extra Start Date refers to the date when an additional, fixed premium charge (Flat Extra) begins on a life insurance policy. This charge is typically applied due to an increased underwriting risk, such as hazardous occupations, high-risk hobbies, or medical conditions","format":"date","example":"2023-01-01"}}},"PartyRiderParticipant":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier assigned to the party insured within the system who was covered under this rider","example":"Party_PI_1"},"partyAgeAtIssue":{"type":"number","format":"int32","description":"The age of the insured at the time the rider was issued","example":50},"riskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONTOBACCO","STANDARDCONVERSIONNONTOBACCO"],"description":"The Risk Class refers to the underwriting category assigned to an applicant based on their health, lifestyle, and medical history, which determines their premium rates for a life insurance policy. Insurers use risk classifications to assess mortality risk and price policies accordingly."},"substandardRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"],"description":"A Substandard Rating (also called Table Rating) is assigned to applicants who do not qualify for Standard or Preferred risk classes due to health conditions, lifestyle risks, or medical history. This rating results in higher premium costs because the insured presents a greater mortality risk."},"flatExtra":{"type":"array","items":{"$ref":"#/components/schemas/FlatExtra"}}}},"RiderCharge":{"type":"object","properties":{"riderExerciseCharge":{"type":"number","description":"One Time Rider Charge that will be Applied upon Rider Activation","format":"double","example":0},"riderExerciseChargeRate":{"type":"number","description":"The rate or percentage applied to calculate the charge for exercising the rider","format":"double","example":0}}},"RiderCoverageLayer":{"type":"object","properties":{"coverageId":{"type":"string","description":"The Coverage ID is a unique identifier assigned to a specific coverage type or benefit within an insurance policy. It helps insurance companies, agents, and policyholders track and differentiate multiple coverage components within a single policy.","example":"Base_Coverage"},"coverageType":{"type":"string","enum":["BASE","RIDER","BASEINCREASE","INTEGRATEDRIDER","RIDERINCREASE","BENEFIT","DISCOUNT","OTHER","UNKNOWN"],"description":"The type of rider denoting if benefit is applicable to base coverage or a distinct  coverage or addition to base coverage or a benefit without any coverage"},"coverageName":{"type":"string","description":"The Coverage Name in a life insurance policy refers to the specific title or label assigned to a coverage type within the policy contract. It helps insurers, agents, and policyholders identify, classify, and manage different coverage components in a policy.","example":"Base_Coverage"},"productCode":{"type":"string","description":"The Plan Code is a carrier-assigned alphanumeric identifier used to uniquely distinguish a specific insurance or annuity product, rate structure, version, and coverage layer within an insurer's portfolio. It is essential for policy administration, pricing, underwriting, and claims processing.","example":"EVGL1"},"coverageTerm":{"type":"number","format":"int32","description":"Coverage Term refers to the number of years that a life insurance policy or specific coverage component is intended to remain in force, providing protection to the insured. It defines the planned duration of insurance coverage, after which the coverage may expire, renew, or convert, depending on the product type.","example":1},"approvedCoverageAmount":{"type":"number","format":"double","description":"The Approved Coverage Amount refers to the specific amount of insurance coverage that has been approved by the insurer during the underwriting process. It represents the face amount (death benefit) the insurer has agreed to issue based on the applicant's risk profile, health, and other underwriting criteria.","example":10000},"currentAmount":{"type":"number","format":"double","description":"The Current Coverage Amount refers to the active or present death benefit or coverage value available under the policy at a specific point in time. It reflects any adjustments, policy changes, withdrawals, or loans that may have altered the original coverage amount.","example":300000},"originalCoverageAmount":{"type":"number","format":"double","description":"The Original Coverage Amount refers to the initial face value or death benefit of a policy at the time of issuance before any policy modifications, withdrawals, loans, or benefit reductions. It represents the starting coverage amount agreed upon when the policy was first issued.","example":300000},"minimumCoverageAmount":{"type":"number","format":"double","description":"The Minimum Coverage Amount at Each Coverage Level refers to the lowest permissible amount of insurance coverage allowed per policy layer, as set by the insurance carrier. It ensures policies remain financially viable and comply with regulatory and underwriting standards.","example":10000},"maximumCoverageAmount":{"type":"number","format":"double","description":"The Maximum Coverage Amount at Each Coverage Level refers to the highest permissible amount of insurance coverage allowed per policy layer, as set by the insurance carrier. ","example":10000000},"grossDeathBenefitAmount":{"type":"number","format":"double","description":"The Gross Death Benefit per Coverage Layer refers to the total pre-deduction death benefit amount assigned to each specific coverage layer within a policy. It represents the sum of all base coverage amounts, riders, and enhancements before applying policy adjustments such as loans, withdrawals, or unpaid premiums.","example":300000},"lowDeathBenefitAmount":{"type":"number","format":"double","description":"Low Death Benefit refers to the lowest possible death benefit guaranteed within each specific coverage component of a policy. This ensures that beneficiaries receive at least a minimum death benefit regardless of market performance, policy changes, or withdrawals.","example":300000},"coverageChangeAmount":{"type":"number","format":"double","description":"The Coverage Change Amount refers to the specific increase or decrease in coverage that occurs within a life insurance policy due to policyholder requests, automatic adjustments, or insurer-initiated changes. This amount reflects the difference between the original or prior coverage amount and the new coverage amount after the change takes effect.","example":3000000},"coverageEffectiveDate":{"type":"string","format":"date","description":"The Coverage Effective Date refers to the date when an increase in coverage or a new coverage component officially takes effect in a life insurance policy. It marks the beginning of the insured’s eligibility for the new or increased benefits.","example":"2023-01-01"},"coverageChangeEffectiveDate":{"type":"string","format":"date","description":"The Coverage Change Effective Date (for a decrease in coverage) refers to the date when the reduced coverage amount officially takes effect in a life insurance policy. It marks the point from which the new lower coverage amount applies.","example":"2023-01-01"},"coverageTerminationDate":{"type":"string","format":"date","description":"The Coverage Termination Date refers to the date when a policy's coverage officially ends, meaning the insured is no longer protected under the contract. After this date, no benefits or claims can be paid unless reinstatement is an option.","example":"2023-01-01"},"unitOfCoverage":{"type":"number","format":"double","description":"The Unit of Coverage refers to the measurement standard used to define the amount of coverage provided under a life insurance policy. It helps insurers calculate premiums, determine benefit payouts, and structure policies consistently.In life insurance, the unit of coverage is typically measured per $1,000 of face amount. ","example":300},"valuePerUnitOfCoverage":{"type":"number","format":"double","description":"The Value per Unit of Coverage refers to the monetary worth of each unit of coverage in a life insurance policy, which is used for premium calculations, benefit payouts, and policy adjustments. This value helps insurers standardize pricing and policy structures.In life insurance, the value per unit represents the cost per $1,000 of coverage or payout per unit of death benefit.In annuities, it determines the payout per annuity unit or per $1,000 of account value.","example":1000},"guidelineSinglePremium":{"type":"number","format":"double","description":"The Guideline Single Premium (GSP) is the maximum single premium payment that can be made into a life insurance policy without causing it to lose its tax-advantaged status as life insurance under IRS guidelines. It is determined based on IRS regulations and ensures that the policy remains compliant with Section 7702 of the Internal Revenue Code.","example":65068.27},"guidelineLevelPremium":{"type":"number","format":"double","description":"The Guideline Level Premium (GLP) is the maximum total premium that can be paid over time into a life insurance policy without violating IRS regulations under Section 7702. It ensures that a policy retains its tax-advantaged status as life insurance and does not become classified as a Modified Endowment Contract (MEC).","example":4695.39},"sevenPayPremium":{"type":"number","format":"double","description":"The 7-Pay Premium refers to the maximum cumulative premium that can be paid into a life insurance policy during the first seven years without causing the policy to become a Modified Endowment Contract (MEC). It is part of the 7-Pay Test, which ensures that life insurance policies do not become overfunded and lose their tax advantages.","example":19807.51},"modalPremium":{"type":"number","format":"double","description":"Modal Premium refers to the actual premium amount a policyholder pays based on the selected billing frequency (mode)—such as monthly, quarterly, semiannual, or annual. It represents the current periodic payment due for the base coverage and any attached riders under a life or annuity insurance policy.","example":1000},"cumulativeModalPremium":{"type":"number","format":"double","description":"Cumulative Modal Premium refers to the sum of actual premium amount a policyholder pays based on the selected billing frequency (mode)—such as monthly, quarterly, semiannual, or annual. It represents the sum of current periodic payment due for the base coverage and any attached riders under a life or annuity insurance policy.","example":1000},"coverageTargetPremium":{"type":"number","format":"double","description":"Coverage Target Premium refers to the designated premium amount on a life insurance policy that:Qualifies for full target-level commissions in the first policy year, and Forms the basis for renewal commissions in subsequent policy years.Note - This is modal premium value","example":300000},"annualPremium":{"type":"number","format":"double","description":"The annual premium is the total amount you would pay for a full year of life insurance or annuity if you made just one payment per year.","example":1000},"overdueModalPremium":{"type":"number","format":"double","description":"refers to a scheduled premium payment that was not received or applied by its due date, based on the policy’s modal frequency (e.g., monthly, quarterly, semi-annual, or annual). It represents a missed payment obligation that remains outstanding and may trigger administrative or policy-level actions","example":1000}}},"Base":{"type":"object","properties":{"currentBase":{"type":"number","format":"double","example":14.32,"description":"Tracked againist Account Value and will be updated on every Anniversary Incremented by gross premiums and credit enhancements.  Set to Investment Value if rider is issed post contract issue.  Adjusted for withdrawals. Reset on Anniversaries"},"ratchetBase":{"type":"number","format":"double","description":"Tracked againist Account Value and will be updated on every Anniversary Incremented by gross premiums and credit enhancements.  Set to Investment Value if rider is issed post contract issue. Adjusted for withdrawals.  Reset on Anniversaries.","example":19.35},"growthBase":{"type":"number","format":"double","description":"Incremented by gross premiums and credit enhancements. Set to Investment Value if rider is issed post contract issue. Adjusted for withdrawals. Reset on Anniversaries by crediting interest based on the interest rate in the Growth Factor Calculation equation box.","example":15.65},"deferralBonus":{"type":"number","format":"double","description":"The Deferral Bonus is configured a percent of a Deferred Bonus Base. It is set to the value on Feature Change, Premium, Annual Processing, GMWB Interest Adjustment transactions","example":12.65},"deferralBonusBase":{"type":"number","format":"double","description":"Captures the basis for calculating the Deferral Bonus.Base used to calculate the annual Deferral Bonus.  Parameters defined in the Deferral tab (GMWB). Incremented by gross premiums.  If GMDB feature added post issue, then set to Investment Value.  Adjusted for withdrawals.  Reset on Contract Anniversaries equal to the Deferral Bonus Base Reset equation box.  Stored in the Transaction Log table.","example":13.12},"simpleInterestBase":{"type":"number","format":"double","description":"Incremented by gross premiums.  Initialized to the Investment Value if GMDB added post issue.  Adjusted for excess withdrawals.  Set to Investment Value on Spousal Continuation.","example":14.21}},"required":["currentBase","ratchetBase","growthBase","deferralBonus","deferralBonusBase","simpleInterestBase"]},"Rider":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2023-01-01T12:00:00.000Z"},"type":{"$ref":"#/components/schemas/RiderType"},"riderName":{"type":"string","example":"Chronic Illness Accelerated Death Benefit Rider","description":"The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit"},"riderElected":{"type":"string","description":"Indicates the election status of the rider on the policy, specifying whether the policyholder has formally elected to include the rider","example":"ELECTED"},"riderCode":{"type":"string","description":"A unique identifier or alphanumeric code assigned to the rider","example":"EVGLHR"},"underwritingStatus":{"$ref":"#/components/schemas/UnderwritingStatus"},"unbornChildIndicator":{"type":"boolean","description":"This will be set to yes if there is no Child rider insured to support Unborn Child"},"qualifiedAdditionalBenefit":{"type":"boolean","description":"Indicates whether the rider provides a qualified benefit under IRS or insurance regulations"},"effectiveDate":{"type":"string","format":"date","description":"Date on which Rider is selected and becomes effective on the policy","example":"2023-01-01"},"exerciseDate":{"type":"string","format":"date","description":"The date the policyholder elects to use or activate the rider benefit","example":"2023-01-01"},"terminationDate":{"type":"string","format":"date","description":"The date on which the rider coverage ends/ is terminated","example":"2023-01-01"},"status":{"$ref":"#/components/schemas/Status"},"coverageId":{"type":"string","example":"Rider_EVGLCHR","description":"An unique identifier assigned to the rider coverage within an insurance coverage or policy layer"},"amount":{"type":"number","description":"The total benefit amount the rider provides (separate from the base policy’s coverage.)","example":0},"annualBenefitAmount":{"type":"number","description":"The maximum benefit amount of the benefit base, policyholder can withdraw each year","example":0,"format":"double"},"riderBenefitAmount":{"type":"number","description":"The Total Benefit Amount represents the maximum guaranteed amount available under the annuity rider over the life of the contract/rider","example":0,"format":"double"},"riderBenefitPercent":{"type":"number","description":"The fixed percentage applied to the Rider Benefit Amount to calculate the annual guaranteed benefit amount","example":100,"format":"double"},"minimumRiderBenefitAmount":{"type":"number","description":"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,"format":"double"},"growthIncomeBenefitAmount":{"type":"number","description":"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,"format":"double"},"riderStoredIncomeBalance":{"type":"number","description":"Amount that can be withdrawn without reducing the yearly or Lifetime rider benefit amount","example":0,"format":"double"},"riderParticipant":{"description":"Note - Use riderParticipants field instead of riderParticipant","type":"array","items":{"$ref":"#/components/schemas/RiderParticipant"}},"additionalBenefitUsageCount":{"type":"number","format":"int32","description":"The number of times the additional benefit has been used.","example":0},"riderParticipants":{"type":"array","items":{"$ref":"#/components/schemas/PartyRiderParticipant"}},"charge":{"$ref":"#/components/schemas/RiderCharge"},"maximumChronicIllnessBenefitPercentage":{"type":"number","description":"The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage","example":2.5},"maximumPeriodicPaymentPeriod":{"type":"number","description":"The maximum duration over which payments can be made under the rider ( in Months)"},"claimStatus":{"type":"boolean","description":"The current status of a claim filed under the rider"},"nextEvaluationDate":{"type":"string","format":"date","description":"The date of the next scheduled review or re-evaluation of an ongoing claim (applicable for riders like chronic illness).","example":"2023-01-01"},"riderPaymentDate":{"type":"string","format":"date","description":"The date the benefit payout under the rider is to be disbursed to the policyholder or beneficiary","example":"2023-01-01"},"terminalRiderPaymentAmount":{"type":"number","description":"The amount paid under the rider benefit.(during a given payout cycle)","example":0},"riderMinimumPaymentAmount":{"type":"number","description":"Deprecated - kept for backwards compatibility","example":0},"maximumCriticalIllnessBenefitPercentage":{"type":"number","description":"The highest percentage of the policy’s face amount that can be accessed under the critical illness rider","example":0},"tierOneMaximumCriticalIllnessBenefitPercentage":{"type":"number","description":"The percentage of the benefit payable under Tier 1 of the critical illness structure (e.g., for mild conditions).","example":0},"tierOneMaximumCriticalIllnessBenefitAmount":{"type":"number","description":"The maximum dollar amount payable under Tier 1 benefits","example":0},"tierTwoMaximumCriticalIllnessBenefitPercentage":{"type":"number","description":"The percentage of the benefit payable under Tier 2(usually for more severe conditions.)","example":0},"tierTwoMaximumCriticalIllnessBenefitAmount":{"type":"number","description":"The maximum dollar amount payable under Tier 2 benefits.","example":0},"tierOneCriticalRiderPaymentDate":{"type":"string","format":"date","description":"The date on which the Tier 1 critical illness rider benefit payment is scheduled or was made","example":"2023-01-01"},"tierOneCriticalRiderPaymentAmount":{"type":"number","description":"The amount of benefit paid under the Tier 1 critical illness","example":0},"tierTwoCriticalRiderPaymentDate":{"type":"string","format":"date","description":"The date on which the Tier 2 critical illness rider benefit payment is scheduled or was made","example":"2023-01-01"},"tierTwoCriticalRiderPaymentAmount":{"type":"number","description":"The amount of benefit paid under the Tier 2 critical illness","example":0},"coverageLayers":{"type":"array","items":{"$ref":"#/components/schemas/RiderCoverageLayer"}},"remainingBenefit":{"type":"number","format":"double","description":"The remaining benefit amount for the rider. Incremented by Premiums and adjusted by withdrawals.","example":10.51},"additionalBenefitUsedUp":{"type":"boolean","description":"Indicates whether the ADL benefit is utilised on the contract."},"totalBenefit":{"type":"number","format":"double","description":"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},"payoutOption":{"type":"string","enum":["SINGLE","JOINT"],"description":"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"},"benefitPercent":{"type":"number","format":"double","description":"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},"annualBenefitLimit":{"type":"number","format":"double","description":"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},"currentAnnualLimit":{"type":"number","format":"double","description":" 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},"remainingAnnualLimit":{"type":"number","format":"double","description":"The GMWB amount still available for withdrawal in the current Contract Year without creating an \"Excess Withdrawal\" situation.","example":6.75},"hypotheticalAnnualLimit":{"type":"number","format":"double","description":"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},"phase":{"type":"string","enum":["ACCUMULATION","INCOME"],"description":"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"},"lastResetDate":{"type":"string","format":"date","description":"User initiates the Reset, Variables product","example":"2023-01-01"},"base":{"$ref":"#/components/schemas/Base"}}},"LoanInterestType":{"type":"string","enum":["FIXED","INDEXED","VARIABLE","ADJUSTABLE"]},"BankDetail":{"type":"object","properties":{"sTART_DATE":{"type":"string","format":"date-time"},"eND_DATE":{"type":"string","format":"date-time"},"branch_Name":{"type":"string"},"bANK_ACCOUNT_PURPOSE":{"type":"string"},"start_DATE":{"type":"string","format":"date-time"},"end_DATE":{"type":"string","format":"date-time"},"bank_ACCOUNT_PURPOSE":{"type":"string"}}},"AccountValuebyPolicyYear":{"type":"object","properties":{"yEAR":{"type":"string","format":"date-time"},"aCCOUNT_VALUE":{"type":"number"},"account_VALUE":{"type":"number"},"year":{"type":"string","format":"date-time"}}},"PolicyValues":{"type":"object","properties":{"account_Valueby_Policy_Year":{"type":"array","items":{"$ref":"#/components/schemas/AccountValuebyPolicyYear"}},"unloanedPortionofAccountValue":{"type":"number","description":"The Unloaned Portion of Account Value refers to the part of the total account value that is not affected by policy loans. Once a policy loan is taken, the total account value is split into loaned and unloaned portions, with the unloaned portion continuing to accrue interest and potential investment returns"},"loanedPortionofAccountValue":{"type":"number","description":"The Loaned Portion of Account Value refers to the amount of a policy’s account value that is used as collateral for a policy loan. This amount is set aside from the Ending Account Value and is used to calculate loan interest accruals. The loaned portion is updated each time a new loan is processed"},"totalLoanAccruedInterest":{"type":"number","description":"The Total Loan Accrued Interest refers to the amount of interest that has accumulated on a policy loan so far within the current year. This interest is added to the outstanding loan balance if it is not paid separately by the policyholder"},"materialChangeDate":{"type":"string","format":"date-time"},"gracePeriodEndDate":{"type":"string","format":"date-time"},"pendingLapseTotalRequiredAmount":{"type":"number"},"lapseProtectionTerminationDate":{"type":"string","format":"date-time"},"lapseProtectionMonthlyPayment":{"type":"number"},"cumulativeLapseProtectionPayment":{"type":"number"}}},"ScheduledEventDetail":{"type":"object","properties":{"sde_id":{"type":"string"},"eventType":{"type":"string"},"status":{"type":"string"},"frequency":{"type":"string"},"systematicProgramRequestDate":{"type":"string","format":"date-time"},"systematicProgramStartDate":{"type":"string","format":"date-time"},"systematicProgramEndDate":{"type":"string","format":"date-time"},"nextSystematicProgramDate":{"type":"string","format":"date-time"}}},"NotesDetail":{"type":"object","properties":{"Priority":{"type":"string","description":"Priority of the note"},"Date":{"type":"string","description":"Date of the note","format":"date-time"},"Summary":{"type":"string","description":"Summary of the note"},"Note_Category":{"type":"string","description":"Category of the note"},"Type":{"type":"string","description":"Type of the note"},"Notes":{"type":"string","description":"Detailed notes"}}},"PolicyData":{"type":"object","properties":{"policyNumber":{"type":"string","description":"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"},"policyStatus":{"type":"string","description":"The Policy Status refers to the current standing of a life insurance or annuity contract, indicating whether it is active, inactive, lapsed, or terminated. The status determines whether the policyholder has coverage and whether policy benefits remain in effect"},"productName":{"type":"string"},"prodModelCode":{"type":"string"},"lOB":{"type":"string"},"planName":{"type":"string","description":"The Product Name refers to the specific life insurance or annuity product selected by the contract owner at the time of policy issuance. It identifies the type of coverage, policy structure, and key features associated with the contract"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration"},"formId":{"type":"string"},"issuingCompany":{"type":"string"},"deathIndicator":{"type":"boolean"},"seriesIndicatorTokenNumber":{"type":"string"},"issueState":{"type":"string","description":"The Policy Issue State refers to the U.S. state where a life insurance or annuity contract was issued. This state determines regulatory oversight, tax implications, and policyholder protections based on state insurance laws"},"residentState":{"type":"string"},"valuesAsOfDate":{"type":"string"},"totalDeathBenefit":{"type":"number","format":"date-time"},"baseFaceAmount":{"type":"number"},"initialFaceAmount":{"type":"number"},"fundValue":{"type":"number"},"indexFloor":{"type":"number"},"indexCap":{"type":"number"},"partRate":{"type":"number"},"cashValue":{"type":"number"},"currentBilledPremium":{"type":"number"},"billingModeCode":{"type":"string"},"billingMode":{"type":"string"},"billingType":{"type":"string"},"yTDPremiumsPaid":{"type":"number"},"cumulativePremiumsPaid":{"type":"number"},"guidelinePremiumsPaid":{"type":"number"},"get_1035ExchangeHistory":{"type":"array","items":{"type":"string"}},"premiumHistory":{"type":"array","items":{"$ref":"#/components/schemas/PremiumHistory"}},"totalWithdrawalsToDate":{"type":"number"},"distributionHistory":{"type":"array","items":{"$ref":"#/components/schemas/DistributionHistory"}},"mECStatusCode":{"type":"boolean"},"owner":{"$ref":"#/components/schemas/Owner"},"insured":{"type":"array","items":{"$ref":"#/components/schemas/Insured"}},"deathBenefitOption":{"$ref":"#/components/schemas/DeathBenefitOption"},"noLapseGuaranteeYears":{"type":"integer","format":"int32"},"guaranteedCreditingRate":{"type":"number"},"fundPortfolioAllocation":{"type":"array","items":{"$ref":"#/components/schemas/FundPortfolioAllocation"}},"coverages":{"type":"array","items":{"$ref":"#/components/schemas/Coverage"}},"rider":{"type":"array","items":{"$ref":"#/components/schemas/Rider"}},"tableRatingCode":{"type":"string"},"tableRating":{"type":"string"},"qualifiedPlanCode":{"type":"boolean"},"qualifiedPlanDescription":{"type":"string"},"loanInterestRate":{"type":"number"},"seriesIndicator":{"type":"string"},"defofLifeInsuranceCode":{"type":"string"},"defofLifeInsurance":{"type":"string"},"clientFullName":{"type":"string"},"currentDeathBenefitAmount":{"type":"number"},"permanentFlatExtraPer$1000Amount":{"type":"number"},"additionalTemporaryFlatExtra":{"type":"number"},"primaryInsuredPermanentFlatExtra":{"type":"number"},"cashValueatLastMaterialChange":{"type":"number"},"dateofLastMaterialChange":{"type":"string"},"premiumPaidOnTheLastMaterialChange":{"type":"number","format":"date-time"},"totalPremiumsPaidSinceLastMaterialChange":{"type":"number"},"healthyMeasureRewardIndicator":{"type":"boolean"},"uLRedeterminationFactor":{"type":"string"},"aSVReportRequested":{"type":"string"},"accountInterestRate":{"type":"number"},"deemedCashValue":{"type":"number"},"totalModalPremium":{"type":"number"},"totalPartialSurrenderChargeSinceInception":{"type":"number"},"nARWeighting":{"type":"number"},"assumedInterestRate":{"type":"number"},"inforceIndicator":{"type":"boolean"},"sevenPayBase":{"type":"number"},"preferredLoanAccountValue":{"type":"number"},"preferredLoanInterest":{"type":"number"},"preferredLoanInterestRate":{"type":"number"},"preferredLoanPrincipal":{"type":"number"},"preferredLoanCollateral":{"type":"number"},"netAmtAtRisk":{"type":"number"},"premCharges":{"type":"number"},"eOYBaseCashValue":{"type":"number"},"reinstatementFullPayment":{"type":"number"},"reinstatementFullPaidTo":{"type":"string"},"reinstatementAdjPayment":{"type":"number"},"eOYCashValue":{"type":"number"},"loanAccruedInterest":{"type":"number"},"surrenderCharge":{"type":"number"},"netSurrenderValue":{"type":"number"},"accountValue":{"type":"number"},"projectIndicator":{"type":"string"},"agent":{"type":"string"},"loanPrincipal":{"type":"number"},"loanAccountValue":{"type":"number"},"loanAccruedInterestEOY":{"type":"number"},"cumulativeGLP":{"type":"number"},"costBasis":{"type":"number","description":"The Cost Basis refers to the total cumulative amount of after-tax premiums paid into a life insurance policy or annuity contract. It represents the non-taxable portion of withdrawals, policy loans, or surrenders, ensuring that policyholders are only taxed on gains above this amount"},"currentDeclaredRateDate":{"type":"string"},"currentAccountInterestRate":{"type":"number"},"guaranteedInterestAccountRate":{"type":"string"},"guaranteedInterestAccountDeclaredDate":{"type":"string"},"longTermGIARate":{"type":"string"},"nLGModalPremium":{"type":"number"},"nLGCumulativePremium":{"type":"number"},"nLGCumulativePremiumwithInterest":{"type":"number"},"cumulativePremium":{"type":"number"},"shadowFundRateA":{"type":"number"},"shadowFundRateB":{"type":"number"},"shadowFundRateC":{"type":"number"},"shadowFundThresholdValueA":{"type":"number"},"shadowFundThresholdValueB":{"type":"number"},"shadowFundThresholdPremiumA":{"type":"number"},"shadowFundThresholdPremiumB":{"type":"number"},"shadowFundAccountValue":{"type":"number"},"benchmarkAmount":{"type":"string"},"benchmarkBonusRate":{"type":"string"},"unisex":{"type":"string"},"iULFixedAccount":{"type":"number"},"iULIndexedAccountA":{"type":"string"},"iULIndexedAccountB":{"type":"string"},"iULFixedAllocation":{"type":"number"},"iULIndexAAllocation":{"type":"string"},"iULIndexBAllocation":{"type":"string"},"iULFixedInterestRate":{"type":"number"},"iULIndexedAccountAInterestRate":{"type":"string"},"iULIndexedAccountBInterestRate":{"type":"string"},"loanInterestType":{"$ref":"#/components/schemas/LoanInterestType"},"imputedInterestRate":{"type":"number"},"requiredPremiumDue":{"type":"number"},"seriesIndicatorOverride":{"type":"string"},"healthyMeasureRewardYears":{"type":"integer","format":"int32"},"tier2RequiredPremAccum":{"type":"number"},"tier3RequiredPremAccum":{"type":"number"},"tier4RequiredPremAccum":{"type":"number"},"tier1RequiredAmtDue":{"type":"number"},"tier2RequiredAmtDue":{"type":"number"},"tier3RequiredAmtDue":{"type":"number"},"tier4RequiredAmtDue":{"type":"number"},"nLGGraceEndDate":{"type":"string"},"tier2GraceEndDate":{"format":"date-time","type":"string"},"tier3GraceEndDate":{"format":"date-time","type":"string"},"tier4GraceEndDate":{"format":"date-time","type":"string"},"multiTierRequiredAmtDue":{"type":"number"},"requiredAmountDue":{"type":"number"},"longTermGIARateDeclaredDate":{"format":"date-time","type":"string"},"loanRepaymentMode":{"type":"string"},"loanRepaymentAmount":{"type":"string"},"lapseProtectionIndicator":{"type":"boolean"},"policyOption":{"type":"string"},"pastDueCharges":{"type":"number"},"lapsePendingEndDate":{"format":"date-time","type":"string"},"leastDeathBenefit":{"type":"number"},"paidToDate":{"type":"string","format":"date-time","description":"Paid to Date refers to the specific date through which a policyholder’s premium payments have fully covered the cost of insurance coverage on a life or annuity policy. It represents the end of the current paid coverage period and is critical for determining the policy`s status (e.g., in-force, in grace period, or lapsed)"},"accumulatedWithdrawals":{"type":"number"},"issueRiskClass":{"type":"string"},"band":{"type":"string"},"accruedLoanInterest":{"type":"number"},"currentInterestRate":{"type":"number"},"borrowedFundRate":{"type":"number"},"borrowedFundValue":{"type":"number"},"nonNYInforceIllustration":{"type":"string"},"unvestedMatchValue":{"type":"number"},"matchCumulatePaymentsSinceIssue":{"type":"number"},"matchYearToDatePayments":{"type":"number"},"priorMonthCOI":{"type":"number"},"monthlyAdminFee":{"type":"number"},"current7PayAnnualAccum":{"type":"number"},"currentGuidelineAnnualPremiumAccum":{"type":"number"},"guidelinePremiumAnnual":{"type":"number"},"lowestDeathBenefitForMECCalculation":{"type":"number"},"numberOfWithdrawalsTakenThisYear":{"type":"number"},"withdrawalsTakenYTD":{"type":"number"},"accountValueAtBOY":{"type":"number"},"lapseProtectionGuaranteePremium":{"type":"number"},"sumOfMonthlyNoLapseGuaranteedPremiumsSinceIssue":{"type":"number"},"productVersion":{"type":"string","description":"The Product Version refers to the specific edition or iteration of an insurance or annuity product, defined by its release date or modifications over time. It helps insurers and policyholders distinguish between different updates, pricing structures, regulatory changes, and feature enhancements within the same product line"},"faceAmount":{"type":"number"},"cumPremForGDB":{"type":"string"},"bankDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankDetail"}},"policyValues":{"type":"array","items":{"$ref":"#/components/schemas/PolicyValues"}},"scheduledEventDetails":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledEventDetail"}},"notesDetails":{"type":"array","items":{"$ref":"#/components/schemas/NotesDetail"}},"eoycashValue":{"type":"number"},"nlgmodalPremium":{"type":"number"},"nlgcumulativePremium":{"type":"number"},"nlgcumulativePremiumwithInterest":{"type":"number"},"iulfixedAccount":{"type":"number"},"iulindexedAccountA":{"type":"string"},"iulindexedAccountB":{"type":"string"},"iulfixedAllocation":{"type":"number"},"iulindexAAllocation":{"type":"string"},"iulindexBAllocation":{"type":"string"},"iulfixedInterestRate":{"type":"number"},"iulindexedAccountAInterestRate":{"type":"string"},"iulindexedAccountBInterestRate":{"type":"string"},"nlggraceEndDate":{"type":"string","format":"date-time"},"lob":{"type":"string"},"ytdpremiumsPaid":{"type":"number"},"mecstatusCode":{"type":"boolean"},"ulredeterminationFactor":{"type":"string"},"asvreportRequested":{"type":"string"},"narweighting":{"type":"number"},"eoybaseCashValue":{"type":"number"}}},"GetIllustrationPolicyInfo":{"type":"object","properties":{"policyData":{"$ref":"#/components/schemas/PolicyData"},"messageResponse":{"$ref":"#/components/schemas/MessageResponse"}}},"LoanFundValue":{"type":"object","properties":{"toTotValPct":{"type":"number"},"fundName":{"type":"string"},"fundNumber":{"type":"string"},"fundTypeCd":{"type":"string"},"interestRate":{"type":"number"},"fundValueAmt":{"type":"number"}}},"Loan":{"type":"object","properties":{"status":{"type":"string"},"principle":{"type":"number"},"interestPaid":{"type":"number"},"chargeRate":{"type":"number"},"creditRate":{"type":"number"},"balance":{"type":"number"},"maxAvailable":{"type":"number"},"loanIntDueAmt":{"type":"number"},"prefIntDueAmt":{"type":"number"},"loanFundValue":{"type":"array","items":{"$ref":"#/components/schemas/LoanFundValue"}}}},"LoanInterestMethod":{"type":"string","enum":["ADVANCE","ARREARS"]},"LoanRepaymentType":{"type":"string","enum":["INTERESTFIRST","PRINCIPALFIRST"]},"LoanValues":{"type":"object","properties":{"totalLoanBalance":{"type":"number","format":"double","description":"The Total Loan Balance refers to the outstanding loan amount on a life insurance policy, including the principal, accrued interest, and any unpaid loan charges. This balance reflects the total amount the policyholder owes the insurance company when a policy loan is taken against the cash value.","example":1000},"totalLoanPrincipal":{"type":"number","format":"double","description":"The Total Loan Principal refers to the original amount borrowed by the policyholder against the cash value of a life insurance policy, excluding any accrued interest or unpaid loan charges. It represents the base loan amount before interest accumulation","example":100},"loanPayoffAmount":{"type":"number","format":"double","description":"The Loan Payoff Amount refers to the total amount required to fully repay a policy loan, including the outstanding loan balance, accrued loan interest, and any adjustments for unearned interest. This value is calculated daily and fluctuates based on the loan’s interest accrual","example":100},"maximumLoanAmount":{"type":"number","format":"double","description":"The Maximum Loan Amount refers to the highest amount a policyholder can borrow against their life insurance policy’s cash value. This limit is determined by the policy’s cash value, outstanding loans, and insurer-specific rules","example":161.81698},"minimumLoanAmount":{"type":"number","format":"double","description":"The Minimum Loan Amount refers to the smallest amount a policyholder can borrow against their life insurance policy’s cash value, as defined by the insurer. This limit ensures that administrative costs and processing fees are justified for each loan transaction","example":100},"totalLoanAccruedInterest":{"type":"number","format":"double","description":"The Total Loan Accrued Interest refers to the amount of interest that has accumulated on a policy loan so far within the current year. This interest is added to the outstanding loan balance if it is not paid separately by the policyholder","example":100},"lastLoanInterestDueDate":{"type":"string","format":"date","description":"The Last Loan Interest Due Date refers to the last policy anniversary date when loan interest was due on an outstanding policy loan. Since loan interest on life insurance policies is typically charged annually, this date always corresponds to the most recent policy anniversary date","example":"2023-01-01"},"totalNumberOfLoan":{"type":"number","format":"int32","description":"The Total Number of Loans refers to the total count of policy loans taken by the policyholder throughout the life of the insurance policy. It tracks each separate loan transaction, regardless of whether previous loans were repaid or still outstanding","example":10},"loanInterestMethod":{"$ref":"#/components/schemas/LoanInterestMethod"},"totalYearToDateLoanTaken":{"type":"number","format":"double","description":"The Total YTD (Year-To-Date) Loan Taken refers to the total amount of policy loans taken by the policyholder within the current calendar or policy year. It tracks all loan transactions processed within the year, excluding prior years` loan activity","example":1000},"loanRepaymentType":{"$ref":"#/components/schemas/LoanRepaymentType"},"minimumLoanRepayment":{"type":"number","format":"double","description":"The Minimum Loan Repayment refers to the smallest amount a policyholder is required to repay on a policy loan, as specified by the insurance company. This ensures that the loan balance is managed and prevents excessive interest accrual, which could lead to policy lapse","example":100},"amountExcessToLoanPayoff":{"type":"number","format":"double","description":"The Amount Excess to Loan Payoff refers to the amount by which the available value exceeds what is required to fully pay off the outstanding policy loan.","example":50}}},"GetLoans":{"type":"object","properties":{"loan":{"$ref":"#/components/schemas/Loan"},"loanFundValue":{"$ref":"#/components/schemas/LoanValues"},"loanValues":{"$ref":"#/components/schemas/LoanValues"},"messageResponse":{"$ref":"#/components/schemas/MessageResponse"}}},"OwnerInformation":{"type":"object","properties":{"type":{"type":"string"},"suffix":{"type":"object","description":"The suffix of the owner party name"},"relationshiptoInsured":{"type":"string","description":"The type of relationship to the owner"},"roleCode":{"type":"string"},"roleName":{"type":"string"},"roleDescription":{"type":"string"},"fullName":{"type":"string","description":"The full name of the owner party"},"firstName":{"type":"string","description":"The first name of the owner party"},"middleName":{"type":"string","description":"The middle name of the owner party"},"lastName":{"type":"string","description":"The last name of the owner party"},"gender":{"type":"string","description":"The gender of the owner party"},"cellPhone":{"type":"string"},"businessPhone":{"type":"object"},"homePhone":{"type":"string"},"eMailAddress":{"type":"object"},"preferredCommunication":{"type":"string"},"city":{"type":"string"},"stateCode":{"type":"string"},"state":{"type":"string"},"stateDescription":{"type":"string"},"zip":{"type":"string"},"dateOfBirth":{"type":"string","description":"The date of birth of the owner","format":"date-time"},"sSN":{"type":"string"},"driverLicenseNumber":{"type":"string"},"driverLicenseState":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"addressLine4":{"type":"object"},"ssn":{"type":"string"},"emailAddress":{"type":"object"}}},"InsuredInformation":{"type":"object","properties":{"roleCode":{"type":"string"},"roleName":{"type":"string"},"roleDescription":{"type":"string"},"fullName":{"type":"string","description":"The full name of the insured party"},"firstName":{"type":"string","description":"The first name of the insured party"},"middleName":{"type":"string","description":"The middle name of the insured party"},"lastName":{"type":"string","description":"The last name of the insured party"},"gender":{"type":"string","description":"The gender of the insured party"},"cellPhone":{"type":"string"},"businessPhone":{"type":"object"},"homePhone":{"type":"string"},"eMailAddress":{"type":"object"},"preferredCommunication":{"type":"string"},"city":{"type":"string"},"stateCode":{"type":"string"},"state":{"type":"string"},"stateDescription":{"type":"string"},"zip":{"type":"string"},"dateOfBirth":{"type":"string","format":"date-time","description":"The date of birth of the insured party"},"sSN":{"type":"string"},"driverLicenseNumber":{"type":"string"},"driverLicenseState":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"addressLine4":{"type":"object"},"ssn":{"type":"string"},"emailAddress":{"type":"object"}}},"BeneficiaryInformation":{"type":"object","properties":{"type":{"type":"string"},"suffix":{"type":"object","description":"The suffix of the beneficiary party name"},"relationshipToInsured":{"type":"string","description":"The type of relationship to the beneficiary"},"percentageOfProceed":{"type":"string"},"roleCode":{"type":"string"},"roleName":{"type":"string"},"roleDescription":{"type":"string"},"fullName":{"type":"string","description":"The full name of the beneficiary party"},"firstName":{"type":"string","description":"The first name of the beneficiary party"},"middleName":{"type":"string","description":"The middle name of the beneficiary party"},"lastName":{"type":"string","description":"The last name of the beneficiary party"},"gender":{"type":"object","description":"The gender of the beneficiary party"},"cellPhone":{"type":"object"},"businessPhone":{"type":"object"},"homePhone":{"type":"string"},"eMailAddress":{"type":"object"},"preferredCommunication":{"type":"object"},"city":{"type":"object"},"stateCode":{"type":"object"},"state":{"type":"object"},"stateDescription":{"type":"object"},"zip":{"type":"object"},"dateOfBirth":{"type":"string","description":"The date of birth of the beneficiary party","format":"date-time"},"sSN":{"type":"string"},"driverLicenseNumber":{"type":"object"},"driverLicenseState":{"type":"object"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"addressLine4":{"type":"object"},"ssn":{"type":"string"},"emailAddress":{"type":"object"}}},"AgentInformation":{"type":"object","properties":{"agentExternalId":{"type":"object","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent"},"agentType":{"type":"object"}}},"PolicyInformation":{"type":"object","properties":{"policyNumber":{"type":"string","description":"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"},"policyStatus":{"type":"string","description":"The Policy Status refers to the current standing of a life insurance or annuity contract, indicating whether it is active, inactive, lapsed, or terminated. The status determines whether the policyholder has coverage and whether policy benefits remain in effect"},"productCode":{"type":"string"},"product":{"type":"string"},"faceAmount":{"type":"number"},"modalPremium":{"type":"number"},"paymentFrequency":{"type":"string"},"riskClassCode":{"type":"string"},"riskClass":{"type":"string"},"tableRatingCode":{"type":"string"},"tableRating":{"type":"string"},"flatExtraAmt":{"type":"object"},"flatExtraDuration":{"type":"object"},"ownerInformation":{"$ref":"#/components/schemas/OwnerInformation"},"insuredInformation":{"type":"array","items":{"$ref":"#/components/schemas/InsuredInformation"}},"beneficiaryInformation":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryInformation"}},"agentInformation":{"$ref":"#/components/schemas/AgentInformation"}}},"GetPolicyDetails":{"type":"object","properties":{"policyInformation":{"$ref":"#/components/schemas/PolicyInformation"},"messageResponse":{"$ref":"#/components/schemas/MessageResponse"}}},"Item":{"type":"object","properties":{"trxId":{"type":"string"},"trxNumber":{"type":"integer","format":"int32"},"trxDate":{"type":"string","format":"date-time"},"typeId":{"type":"string"},"typeDesc":{"type":"string"},"status":{"type":"string"},"statusDesc":{"type":"string"},"amtProcessed":{"type":"number","format":"double"},"faceAmount":{"type":"object"},"policyNumber":{"type":"string","description":"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"},"conversionLoadStatus":{"type":"string"},"conversionLoadDate":{"type":"string","format":"date-time"}}},"PaymentInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"EFTInformation":{"type":"object","properties":{"routingNumber":{"type":"string"},"accountNumber":{"type":"string"},"type":{"type":"string"},"role":{"type":"string"}}},"Person":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the party"},"lastName":{"type":"string","description":"The last name of the party"},"role":{"type":"string"},"roleDesc":{"type":"object"},"partyType":{"type":"string","description":"Defines Party type example individual or Organization or Trust. For Insured and Annuitant this should always be Individual"},"addresses":{"$ref":"#/components/schemas/Address"},"dateOfBirth":{"type":"string","description":"The date of birth of the party"},"mailIndicator":{"type":"boolean"},"eFTInformation":{"$ref":"#/components/schemas/EFTInformation"},"externalId":{"type":"object"},"eftinformation":{"$ref":"#/components/schemas/EFTInformation"}}},"PolicyAdhocInfo":{"type":"object","properties":{"currentDate":{"type":"string"},"contractNumber":{"type":"string"},"clientId":{"type":"string"},"qualificationType":{"type":"string"},"issueDate":{"type":"string","description":"The Policy Issue Date, also known as the Policy Launch Date, is the date when the insurance company officially issues the policy to the client. This occurs after the application is approved, the insured accepts the offer, and payment information is provided. It marks the formal activation of the policy and triggers policy delivery"},"productName":{"type":"string"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration"},"contractStatus":{"type":"string"},"issueState":{"type":"string","description":"The Policy Issue State refers to the U.S. state where a life insurance or annuity contract was issued. This state determines regulatory oversight, tax implications, and policyholder protections based on state insurance laws"},"sourceSystem":{"type":"string"},"maturityDate":{"type":"string","description":"The Policy Maturity Date refers to the date when a life insurance policy reaches its maturity or an annuity contract reaches its maximum annuitization age. It is based on the Policy Start Date and determines when benefits become payable or coverage ends"},"initialPremium":{"type":"number"},"accountValue":{"type":"number"},"surrenderCharge":{"type":"number"},"cashValue":{"type":"number"},"totalWithdrawal":{"type":"number"},"accumulatedCashValue":{"type":"number"},"surrenderValue":{"type":"number","description":"The Account Surrender Value refers to the amount an insurance company pays to the policyholder when they voluntarily cancel (surrender) their life insurance policy or annuity before its maturity or death benefit payout. This value is determined after deducting surrender charges, outstanding loans, and applicable fees from the policy’s total account value"},"costBasisPreTefra":{"type":"number"},"costBasisPostTefra":{"type":"number"},"faceAmount":{"type":"number"},"gMIR":{"type":"number"},"deathBenefitValue":{"type":"number"},"netCashSurrenderValue":{"type":"number"},"insuranceAmount":{"type":"number"},"cumulativePremiums":{"type":"number"},"yTDPremium":{"type":"number"},"grossSurrenderAmount":{"type":"number"},"costBasisAmount":{"type":"number"},"people":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"gmir":{"type":"number"},"ytdpremium":{"type":"number"}}},"PeopleInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"Transactions":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"AllTransactions":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"FastDataBackup":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account Number"},"backupDate":{"type":"string","description":"Backup Date","format":"date"},"getCVQ":{"description":"Get CVQ","allOf":[{"$ref":"#/components/schemas/GetCVQ"}]},"getIllustrationPolicyInfo":{"description":"Get Illustration Policy Info","allOf":[{"$ref":"#/components/schemas/GetIllustrationPolicyInfo"}]},"getLoans":{"description":"Get Loans","allOf":[{"$ref":"#/components/schemas/GetLoans"}]},"getPolicyDetails":{"description":"Get Policy Details","allOf":[{"$ref":"#/components/schemas/GetPolicyDetails"}]},"getPaymentInfo":{"description":"Payment Info","allOf":[{"$ref":"#/components/schemas/PaymentInfo"}]},"policyAdhocInfo":{"description":"Policy Adhoc Info","allOf":[{"$ref":"#/components/schemas/PolicyAdhocInfo"}]},"peopleInfo":{"description":"People Info","allOf":[{"$ref":"#/components/schemas/PeopleInfo"}]},"transactions":{"description":"Transactions","allOf":[{"$ref":"#/components/schemas/Transactions"}]},"allTransactions":{"description":"All Transactions","allOf":[{"$ref":"#/components/schemas/AllTransactions"}]}}},"ApiRequestHeader":{"type":"object","properties":{"externalId":{"type":"string"},"externalUserId":{"type":"string"},"externalSystemId":{"type":"string"},"externalUserCompHrchyId":{"type":"string"},"muleCorrelationId":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"apiRequestUUID":{"type":"string"},"apiName":{"type":"string"},"externalTransactionName":{"type":"string"},"clientCode":{"type":"string"},"externalUserIdValid":{"type":"boolean"}},"required":["externalId","externalUserId","externalSystemId","externalUserCompHrchyId","muleCorrelationId","timestamp","apiRequestUUID","apiName","externalTransactionName","clientCode","externalUserIdValid"]},"PolicyCommonRequest":{"type":"object","properties":{"contractNumber":{"type":"number"},"companyId":{"type":"number"},"companyHierarchyId":{"type":"number"},"planCode":{"type":"string"},"policyNumber":{"type":"number"},"cvgId":{"type":"number"}},"required":["contractNumber","companyId","companyHierarchyId","planCode","policyNumber","cvgId"]},"FundDetail":{"type":"object","properties":{"chAccountDesc":{"type":"string"},"chDivisionDesc":{"type":"string"},"chAccountDivisionDesc":{"type":"string"},"inAccType":{"type":"number"},"inDivType":{"type":"number"},"chAccount":{"type":"string"},"chDivision":{"type":"string"}},"required":["chAccountDesc","chDivisionDesc","chAccountDivisionDesc","inAccType","inDivType","chAccount","chDivision"]},"AllPolicyFundsResponse":{"type":"object","properties":{"apiRequestHeader":{"$ref":"#/components/schemas/ApiRequestHeader"},"policyCommonRequest":{"$ref":"#/components/schemas/PolicyCommonRequest"},"status":{"$ref":"#/components/schemas/Status"},"fundDetails":{"type":"array","items":{"$ref":"#/components/schemas/FundDetail"}}},"required":["apiRequestHeader","policyCommonRequest","status","fundDetails"]},"PolicyEvent":{"type":"object","properties":{"policyNumber":{"type":"string","description":"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"},"event":{"type":"string","description":"The transaction type of the current policy snapshot"},"timestamp":{"format":"date-time","type":"string"},"version":{"type":"integer","format":"int32"}}},"DistributionType":{"type":"string","enum":["WIREHOUSE","REGISTEREDINVESTMENTADVISER","INDEPENDENTAGENCY","FINANCIALPLANNINGFIRM","FINANCIALINSTITUTION","BROKER_DEALER","THIRDPARTYDIRECTTOCONSUMER","BANKMARKET","BROKERAGE_INDEPENDENTMARKET","CAPTIVEMARKET","AFFILIATEDAGENCY","INSTITUTIONALMARKET","FARMERSMLEA"]},"HoldingForm":{"type":"string","enum":["INDIVIDUAL","GROUP","JOINTINDIVIDUAL"]},"Product":{"type":"object","properties":{"lineOfBusiness":{"type":"string","enum":["LIFE","ANNUITY","MUTUALFUND","CERTIFICATEOFDEPOSIT","BROKERAGE","OTHER"],"description":"Insurance and annuities are two distinct product lines of business (LOB) in the financial and insurance industry. Each serves different financial protection and income planning purposes"},"planName":{"type":"string","description":"The Product Name refers to the specific life insurance or annuity product selected by the contract owner at the time of policy issuance. It identifies the type of coverage, policy structure, and key features associated with the contract","example":"Everglades Premium Match"},"productType":{"$ref":"#/components/schemas/ProductType"},"marketingName":{"type":"string","description":"The Product Marketing Name refers to the branded name assigned by an insurance company to a specific life insurance or annuity product for marketing and sales purposes. It distinguishes products within an insurer`s portfolio and highlights key features and benefits for consumers","example":"Everglades"},"shortName":{"type":"string","description":"The Product Short Name is a condensed version of the full Product Marketing Name, typically used for internal systems, policy documents, billing, and reporting. It provides a simplified reference while still identifying the product accurately","example":"EVGL UL"},"distribution":{"$ref":"#/components/schemas/DistributionType"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","example":"PLAN001"},"generalLedgerPlanCode":{"type":"string","description":"The GL Plan Code (General Ledger Plan Code) is a carrier-assigned accounting code used to track insurance products and financial transactions within an insurer’s general ledger system. It is essential for financial reporting, revenue allocation, and regulatory compliance","example":"V2201"},"holdingForm":{"$ref":"#/components/schemas/HoldingForm"},"renewable":{"type":"string","description":"Renewable refers to a policy feature that allows the insured to extend coverage beyond the original term without requiring medical underwriting or a new application. This is commonly found in Term Life Insurance policies"},"productVersion":{"type":"string","description":"The Product Version refers to the specific edition or iteration of an insurance or annuity product, defined by its release date or modifications over time. It helps insurers and policyholders distinguish between different updates, pricing structures, regulatory changes, and feature enhancements within the same product line","example":"2021.10.15"},"sourceSystemPlanCode":{"type":"string","description":"The Source System Plan Code is the identifier assigned to a coverage from the source carrier.","example":"CARRIER01"}}},"PolicyStatus":{"type":"string","enum":["PENDINGISSUED","NOTISSUED","CANCELEDNOPREMIUM","ACTIVE","CANCELEDFREELOOK","PENDINGLAPSE","LAPSE","TERMINATED","MATURED","SURRENDERED","LIVINGCLAIMPENDING","DEATHCLAIMPENDING","DEATHCLAIMPAID","NOTTAKEN","ISSUED","PARTIALDEATHCLAIM","PAYOUT"]},"RestrictStatus":{"type":"string","enum":["LEGAL","OPERATIONAL","COMPLIANCE","MECRESTRICT","OVERPAYMENT","COLLATERALLYASSIGNEDUNSPECIFIED","DIVORCE"]},"IssueType":{"type":"string","enum":["FULLUNDERWRITING","SIMPLIFIED","GUARANTEEISSUE","REDUCEDUNDERWRITING","EXPRESSUNDERWRITING","MASSUNDERWRITING","AVIATION"]},"Currency":{"type":"string","enum":["USD","CAD","AUD","NZD","GBP","EUR","CHF","JPY"]},"PolicyDates":{"type":"object","properties":{"policyStartDate":{"type":"string","format":"date","description":"The Policy Start Date refers to the official date on which the policy becomes effective and coverage begins. This date is critical for determining premium payments, coverage eligibility, policy anniversaries, and contractual obligations","example":"2023-01-01"},"applicationDate":{"type":"string","format":"date","description":"The Application Date, also referred to as the Policy Sign Date, is the date when the policyholder completes and signs the insurance or annuity application. This marks the official request for coverage but does not necessarily mean the policy is active yet","example":"2023-01-01"},"applicationReceivedDate":{"type":"string","format":"date","description":"The Application Received Date refers to the date when Zinnia (or the designated insurance company/administrator) officially receives the completed insurance or annuity application","example":"2023-01-01"},"issueDate":{"type":"string","format":"date","description":"The Policy Issue Date, also known as the Policy Launch Date, is the date when the insurance company officially issues the policy to the client. This occurs after the application is approved, the insured accepts the offer, and payment information is provided. It marks the formal activation of the policy and triggers policy delivery","example":"2023-01-01"},"parameterLockDate":{"type":"string","format":"date","description":"The effective date used as applicable version of rate-locked parameters for this contract.","example":"2023-01-01"},"applicationInGoodOrderDate":{"type":"string","format":"date","description":"The Application IGO Date (In Good Order Date) refers to the date when the submitted application is deemed complete and accurate by Zinnia or the insurer, meaning it is ready for underwriting and processing but does not yet include the initial premium payment","example":"2023-01-01"},"contestabilityStartDate":{"type":"string","format":"date","description":"The Contestability Start Date refers to the beginning of the contestability period, which is the time frame in which an insurance company can investigate and deny a claim if material misrepresentations or fraud are found in the application","example":"2023-01-01"},"contestabilityEndDate":{"type":"string","format":"date","description":"The Contestability End Date is the date when the contestability period expires, meaning the insurer can no longer deny a claim based on misrepresentation or omission in the application, unless fraud is proven","example":"2023-01-01"},"policyDeliveryDate":{"type":"string","format":"date","description":"The Policy Delivery Date refers to the date when the policyholder is officially notified that their policy is available, either through an online portal, email, SMS, or physical mail. This date is critical because it marks the start of the free look period, allowing the policyholder to review the contract and cancel if needed","example":"2023-01-01"},"previousPolicyAnniversaryDate":{"type":"string","format":"date","description":"The Previous Policy Anniversary Date refers to the most recent past annual recurrence of the Policy Start Date. This date is used for tracking past premium payments, benefit updates, policy renewals, and cash value calculations","example":"2023-01-01"},"previousPolicyMonthiversaryDate":{"type":"string","format":"date","description":"The Previous Policy Monthiversary Date refers to the most recent past monthly recurrence of the Policy Start Date. It is used for tracking monthly premium payments, cost of insurance (COI) deductions, cash value updates, and policy charges","example":"2023-01-01"},"nextAnniversaryDate":{"type":"string","format":"date","description":"The Next Policy Anniversary Date refers to the upcoming annual recurrence of the policy’s start date. It is based on the Policy Start Date and marks key policy milestones such as premium due dates, cash value updates, policy renewals, and benefit adjustments","example":"2023-01-01"},"maturityDate":{"type":"string","format":"date","description":"The Policy Maturity Date refers to the date when a life insurance policy reaches its maturity or an annuity contract reaches its maximum annuitization age. It is based on the Policy Start Date and determines when benefits become payable or coverage ends","example":"2023-01-01"},"policyTerminationDate":{"type":"string","format":"date","description":"The Policy Termination Date is the date when a life insurance or annuity policy officially ends, meaning coverage ceases, and no further benefits or obligations exist under the contract. The reason for termination may vary, including policy lapse, surrender, maturity, or claim payout","example":"2023-01-01"},"initialPaymentExpiryDate":{"type":"string","format":"date","description":"The Initial Payment Amount Expiration Date refers to the deadline by which the initial premium payment must be made to keep the policy offer valid and ensure the policy goes into effect., if not received Policy will be Canceled due to no Premium Set at Issuance","example":"2023-01-01"},"nextMonthiversaryDate":{"type":"string","format":"date","description":"The Next Policy Monthiversary Date refers to the same day of each month that corresponds to the Policy Start Date, marking the monthly recurrence of the policy. It is used for monthly premium payments, cost deductions, cash value calculations, and interest crediting","example":"2023-01-01"},"claimApprovalDate":{"type":"string","format":"date","description":"The Claim Approval Date is the date when an insurance company officially approves a claim for payment after verifying the claim details, policy coverage, and required documentation","example":"2023-01-01"},"certifiedReceivedDate":{"type":"string","description":"The Certified Received Date refers to the date when the insurance company officially receives the certified death paperwork (such as a death certificate) required to process a life insurance claim. This date marks the beginning of the formal claims verification process","format":"date","example":"2023-01-01"},"dateOfDeathReportedNotification":{"type":"string","format":"date","description":"The Date of Death Reported / Notification refers to the date on which the insurance company is officially notified of the insured`s passing. This date is critical as it marks the start of the claims process and determines when the insurer begins reviewing the claim","example":"2023-01-01"},"deferralEndDate":{"type":"string","format":"date","description":"The Deferral End Date refers to the contractually set date on a deferred annuity or inherited IRA by which the policyholder must take action—either by starting withdrawals, annuitizing, or surrendering the policy. If no action is taken, the contract may auto-surrender, forcing a lump-sum payout or triggering Required Minimum Distributions (RMDs)","example":"2023-01-01"},"conversionDate":{"type":"string","format":"date","description":"The Conversion Date refers to the date on which an insurance or annuity contract is transferred or migrated from one platform, system, or policy type to another. This is commonly seen in policy administration system updates, carrier mergers, or policy conversions","example":"2023-01-01"},"paidToDate":{"type":"string","format":"date","description":"Paid to Date refers to the specific date through which a policyholder’s premium payments have fully covered the cost of insurance coverage on a life or annuity policy. It represents the end of the current paid coverage period and is critical for determining the policy's status (e.g., in-force, in grace period, or lapsed)","example":"2023-01-01"},"paidUpDate":{"type":"string","format":"date","description":"The date when all required premium payments on a life insurance policy have been made","example":"2023-01-01"},"endowmentDate":{"type":"string","format":"date","description":"The policy anniversary date on which the Level Term Period expires and the policy reaches endowment.","example":"2023-01-01"}}},"CostBasis":{"type":"object","properties":{"costBasis":{"type":"number","description":"The Cost Basis refers to the total cumulative amount of after-tax premiums paid into a life insurance policy or annuity contract. It represents the non-taxable portion of withdrawals, policy loans, or surrenders, ensuring that policyholders are only taxed on gains above this amount","example":198},"costBasisDate":{"type":"string","format":"date","description":"The Cost Basis Date refers to the date on which the cost basis value of a life insurance policy or annuity contract is calculated. The cost basis represents the total amount of after-tax money contributed to the policy or annuity and is used to determine the taxable portion of withdrawals, loans, or payouts","example":"2023-01-01"},"preTaxEquityAndFiscalResponsibilityActBasis":{"type":"number","format":"double","description":"The Pre-TEFRA Basis refers to the cost basis of a life insurance policy or annuity before the Tax Equity and Fiscal Responsibility Act (TEFRA) of 1982 took effect. This distinction is important because TEFRA introduced new tax regulations on insurance products, including how withdrawals, policy loans, and annuities are taxed","example":161.81698},"preTechnicalAndMiscellaneousRevenueActAmount":{"type":"number","format":"double","description":"Cost basis of a policy prior to Technical and Miscellaneous Revenue Act (TAMRA) of 1988.SB FIA - do not have 403 Qual Type, but if an exchange policy has it this will need to be housed and tracked going forward.","example":161.81698},"postTechnicalAndMiscellaneousRevenueActAmount":{"type":"number","format":"double","description":"Cost basis of a policy after Technical and Miscellaneous Revenue Act (TAMRA) of 1988. SB FIA - do not have 403 Qual Type, but if an exchange policy has it this will need to be housed and tracked going forward.","example":161.81698},"changeAmount":{"type":"number","format":"double","description":"The Cost Basis Change Amount refers to the difference between the old and new cost basis of a life insurance policy or annuity. It reflects adjustments due to premium payments, withdrawals, policy loans, 1035 exchanges, or other financial transactions that impact the total cost basis.","example":161.81698}}},"FixedCostPeriodUnit":{"type":"string","description":"The unit of measure for the Fixed Cost Period. YEARS indicates the period is measured in policy years from the policy start date. AGE indicates the period is measured until the insured reaches a specific age. For Everly IUL T65 products, AGE with value 65 maps to OLI_LU_BENEPERIOD TC=16.","enum":["YEARS","AGE"]},"CommissionOption":{"type":"string","enum":["OPTIONA","OPTIONB","NOCOMMISSION","STANDARD","TRAIL"]},"AccountValues":{"type":"object","properties":{"beginningAccountValue":{"type":"number","description":"The Account Value refers to the total cash value of a life insurance policy or annuity at the beginning of each transaction, including both loaned and unloaned amounts. It represents the policy’s accumulated value before deductions, withdrawals, or new transactions","example":161.81698},"endingAccountValue":{"type":"number","description":"The Current Account Value refers to the total cash value of a life insurance policy or annuity (including loaned and unloaned amounts) as of the last processed transaction. This value is used to determine the available account value (AV) for policyholders and is also the amount on which Fixed Interest is credited","example":161.81698},"minimumRequiredAccountValue":{"type":"number","description":"The Minimum Required Account Value refers to the lowest amount of account value that must be maintained in a life insurance policy or annuity to keep the contract active and prevent policy lapse. If the account value falls below this threshold, the policy may enter a grace period, require additional premium payments, or terminate. For some products this may be \"0\"","example":0},"accountValueByPolicyYear":{"type":"number","description":"The Account Value by Policy Year refers to the total account value at the beginning of each policy year, before any new transactions such as premium payments, withdrawals, loans, or interest credits are applied. This value helps track policy growth, cash value accumulation, and available funds over time","example":0},"unloanedPortionOfAccountValue":{"type":"number","description":"The Unloaned Portion of Account Value refers to the part of the total account value that is not affected by policy loans. Once a policy loan is taken, the total account value is split into loaned and unloaned portions, with the unloaned portion continuing to accrue interest and potential investment returns","example":161.81698},"loanedPortionOfAccountValue":{"type":"number","description":"The Loaned Portion of Account Value refers to the amount of a policy’s account value that is used as collateral for a policy loan. This amount is set aside from the Ending Account Value and is used to calculate loan interest accruals. The loaned portion is updated each time a new loan is processed","example":0},"surrenderValue":{"type":"number","description":"The Account Surrender Value refers to the amount an insurance company pays to the policyholder when they voluntarily cancel (surrender) their life insurance policy or annuity before its maturity or death benefit payout. This value is determined after deducting surrender charges, outstanding loans, and applicable fees from the policy’s total account value","example":161.81698},"surrenderValueWithoutMarketValueAdjustment":{"type":"number","format":"double","description":"Sum of money an insurance company pays to the policyholder or account owner upon the surrender of a policy/account without MVA value included","example":161.81698},"surrenderValueWithZeroMarketValueAdjustment":{"type":"number","format":"double","description":"For Valuation (Reserving purposes). The account surrender value where the surrender charge has been recalculated assuming $0 MVA","example":161.81698},"guaranteedCashSurrenderValueFixed":{"type":"number","description":"The Guaranteed Cash Surrender Value (Fixed) refers to the minimum cash value that a policyholder is assured to receive if they surrender their life insurance policy, regardless of market conditions. This amount is contractually defined and does not fluctuate with policy performance","format":"double","example":161.81698},"guaranteedCashSurrenderValueIndexed":{"type":"number","description":"The indexed amount of cash that the policyholder is guaranteed to receive upon surrendering the policy before its maturity.Only required for Annuity FIA Products","format":"double","example":161.81698},"netAmountAtRisk":{"type":"number","description":"The Net Amount at Risk (NAR) is the difference between the policy’s total death benefit and the policy’s account value (cash value). It represents the portion of the death benefit that the insurance company is at risk of paying out beyond the policyholder’s accumulated account value","example":16.81698},"deemedAccountValue":{"type":"number","description":"The Deemed Account Value refers to an adjusted account value used for specific policy calculations, regulatory compliance, or benefit determinations. It may differ from the actual account value due to adjustments for policy loans, fees, surrender charges, or regulatory requirements","example":16.81698},"initialPremiumRequestAmount":{"type":"number","description":"The Initial Premium Request Amount refers to the first premium payment made by the policyholder (party) to initiate coverage on a life insurance or annuity contract. This amount is required to activate the policy and begin accumulating benefits","example":99},"initialPremiumAppliedAmount":{"type":"number","description":"The Initial Premium Applied Amount refers to the portion of the initial premium payment that is officially applied to the policy after processing. This amount determines when the policy becomes active and how funds are allocated within the contract","example":99},"initialPaymentAmountReceivedDate":{"type":"string","format":"date","description":"The Initial Premium Amount Received Date refers to the date when the insurance company's home office officially receives the first premium payment for a life insurance policy or annuity contract. This date is crucial as it determines when the policy processing begins and may impact policy activation timelines","example":"2023-01-01"},"cumulativePremiumSinceIssue":{"type":"number","description":"The Cumulative Premium Since Issue refers to the total amount of premiums paid into a life insurance policy or annuity contract from the policy’s start date (issue date) to the present. This figure represents all premium contributions made by the policyholder over time","example":198},"totalYearToDatePremiumAmount":{"type":"number","description":"The Total (YTD) Premium Amount refers to the total premium applied to a life insurance policy or annuity contract within the current calendar or policy year, up to the present date. This value is used to track year-to-date contributions and ensure policy funding requirements are met","example":198},"modifiedEndowmentContractAuthorization":{"type":"string","enum":["true","false"],"description":"MEC Authorization refers to the approval process required when a life insurance policy is classified as a Modified Endowment Contract (MEC). A MEC is a permanent life insurance policy that fails the IRS \"7-Pay Test,\" resulting in different tax treatment of policy loans and withdrawals. MEC Authorization is typically required from the policyholder before processing transactions that could convert the policy into a MEC, ensuring they understand the tax consequences."},"projectedLapseIndicator":{"type":"boolean","description":"The Projected Lapse Indicator is a forecast that indicates whether a life insurance policy is expected to lapse within the next policy year based on its current account value, premium payments, cost of insurance (COI), and other policy charges"},"policyGainAmount":{"type":"number","description":"The Policy Gain Amount is the difference between the policy’s total account value and the cost basis. It represents the amount of gain that may be subject to taxation if withdrawn or surrendered","example":0},"uncollectedCharges":{"type":"number","description":"Uncollected Charges refer to negative charges assessed when a policy is in a lapse condition due to insufficient funds in the policy’s account value. These charges represent policy fees, cost of insurance (COI), and other deductions that could not be collected because the policy had inadequate cash value","example":0},"annualTargetPremium":{"type":"number","description":"The Annual Target Premium is the calculated premium amount used to determine commissions for agents and brokers. It represents the portion of the policy premium that qualifies for commission payments and is calculated based on specific monthly charges within the policy. The Annual Target Premium for the calculation of commissions will be calculated using the following formula: [(Monthly Expense Charge + Monthly Unit Charge + Monthly Coverage Charge + Children’s Term Insurance Rider Charge) ÷ (1 – Payment Charge)] × 12]","example":99.9,"format":"double"},"modalTargetPremium":{"type":"number","description":"The Modal Target Premium is the periodic premium amount used for commission calculations based on the chosen payment mode (e.g., monthly, quarterly, semi-annually, or annually). It is derived from the Annual Target Premium and represents how much of the target premium is allocated to each payment cycle. Modal Target Premium for the calculation of commissions will be calculated using the following formula: [(Monthly Expense Charge + Monthly Unit Charge + Monthly Coverage Charge + Children’s Term Insurance Rider Charge) ÷ (1 – Payment Charge)] × 12]","example":99.9,"format":"double"},"annualizedPremium":{"type":"number","description":"Annualized Premium refers to the total amount of premium a policyholder is expected to pay over the course of a full year, assuming the policy remains active and all scheduled premium payments are made on time and in full. It is a standardized representation of premium income, regardless of payment mode (monthly, quarterly, semiannual, or annual)","example":99.99,"format":"double"},"unearnedPremium":{"type":"number","description":"Unearned Premium is the portion of a policyholder’s premium that has been paid in advance but corresponds to future coverage—i.e., insurance protection that has not yet been provided. It represents a liability on the insurer’s books because it reflects coverage that still needs to be delivered","example":99.99,"format":"double"},"excessPremium":{"type":"number","format":"double","description":"Excess Premium refers to the amount of premium paid into a life insurance or annuity policy that exceeds the allowable or intended limits set by the contract, regulatory testing (e.g., MEC or Guideline Premium Tests), or policy design (e.g., target or planned premiums).","example":99.99},"outstandingLifetimePremium":{"type":"number","format":"double","description":"Outstanding Lifetime Premium refers to the total amount of premium that remains unpaid over the lifetime of the policy, based on the expected premium schedule set at issue or during the most recent plan update. It represents the future premium obligation assuming the policyholder continues to pay until the end of the coverage period or maturity","example":99.99},"suppressionIndicator":{"type":"boolean","description":"The Suppression Indicator is a flag or marker used in policy administration systems to prevent certain actions, notifications, or transactions from being processed or displayed. It is commonly applied to billing, statements, reports, or policy updates based on specific business rules"},"interestEarned":{"type":"number","format":"double","description":"The Interest Earned refers to the amount of interest credited to a life insurance policy or annuity contract based on the accumulated account value. This interest may be guaranteed (fixed) or variable (market-based), depending on the policy type","example":99.12},"totalNetWithdrawalSinceIssue":{"type":"number","description":"Running total of all Net Withdrawals since policy issuance","format":"double"},"totalGainWithdrawnSinceIssue":{"type":"number","description":"Total of all earnings withdrawn since policy issue","format":"double"},"employeeRetirementIncomeSecurityActIndicator":{"type":"boolean","description":"ERISA Indicator is a field that specifies whether a policy or contract is subject to the Employee Retirement Income Security Act of 1974 (ERISA) — a federal law that governs certain employer-sponsored retirement and benefit plans in the U.S."},"cumulativePremiumReceived":{"type":"number","format":"double","description":"Cumulative Premium Received refers to the total sum of premium payments that have been successfully received and applied to a policy from the date of issuance up to a given point in time.","example":99.99},"previousModePremiumReceived":{"type":"number","format":"double","description":"Previous Mode Premium Received refers to the actual premium amount collected during the prior billing mode period for a specific policy or coverage. This value reflects what was received for the most recently completed premium cycle (monthly, quarterly, semi-annual, or annual), immediately preceding the current period.","example":99.99},"offageAmount":{"type":"number","format":"double","description":"Offage Amount refers to the difference between the expected or scheduled value and the actual value applied or received on a policy transaction, typically related to premium payments, disbursements, or reserve adjustments. It acts as a variance indicator, flagging whether there is an overage or shortage that needs reconciliation.","example":99.99},"totalGuaranteedCashSurrenderValue":{"type":"number","format":"double","description":"The minimum guaranteed amount that the policyholder would receive upon surrendering the contract, as defined by the contracts guaranteed values.","example":161.81698}}},"WithdrawalValues":{"type":"object","properties":{"totalWithdrawalAmount":{"type":"number","format":"double","description":"The Total Withdrawal Amount refers to the cumulative amount of funds withdrawn from a life insurance policy or annuity by the policyholder. This includes all withdrawals made since the policy’s inception, whether taken as partial surrenders, cash value withdrawals, or systematic distributions","example":0},"freeWithdrawalAmount":{"type":"number","format":"double","description":"The Free Withdrawal Amount refers to the maximum amount a policyholder can withdraw from their life insurance policy or annuity in a contract year without incurring a surrender charge. This limit is set by the insurer and is typically expressed as a percentage of the account value or premiums paid","example":0},"yearToDateFreeWithdrawalAmount":{"type":"number","format":"double","example":0,"description":"The YTD Free Amount (Year-To-Date Free Withdrawal Amount) refers to the total amount withdrawn so far in the current contract year that was within the free withdrawal limit, meaning it did not incur surrender charges. This tracks how much of the allowable free withdrawal limit has been used"},"minimumWithdrawalAmount":{"type":"number","format":"double","description":"The Minimum Withdrawal Amount refers to the smallest amount a policyholder can withdraw from their life insurance policy or annuity in a single transaction, as defined by the insurer. This ensures that withdrawals remain administratively efficient and align with policy rules","example":1},"maximumWithdrawalAmount":{"type":"number","format":"double","description":"The Maximum Withdrawal Amount refers to the highest amount a policyholder can withdraw from their life insurance policy or annuity in a single transaction or within a policy year, as set by the insurer. This ensures that withdrawals do not deplete the policy’s cash value too quickly or violate contract terms","example":161.81698},"annualWithdrawalLimitNoCoverageDecrease":{"type":"number","format":"double","description":"The Annual Withdrawal Limit for No Coverage Decrease refers to the maximum amount a policyholder can withdraw from their life insurance policy within a policy year without reducing the death benefit or coverage amount. This ensures that policyholders can access cash value while maintaining full coverage","example":322.678939},"maximumWithdrawalRequestDuringVestingPeriod":{"type":"number","format":"int32","description":"The Max Withdrawal Request Allowed During Vesting Period refers to the highest number of withdrawal transactions permitted within the vesting period of a life insurance policy or annuity. This ensures policyholders follow contract rules while maintaining eligibility for vested benefits","example":1},"yearToDateNumberOfWithdrawal":{"type":"number","description":"The YTD (Year-To-Date) Number of Withdrawals refers to the total count of withdrawal transactions made by the policyholder from the beginning of the policy year to the present date. This tracks how frequently funds have been withdrawn within the current policy year","example":1,"format":"int32"},"maximumWithdrawalRequestAfterVestingPeriod":{"type":"number","description":"The Max Withdrawal Request Allowed After Vesting Period refers to the highest number of withdrawals a policyholder can make per year or over the life of the policy after the vesting period has ended. This ensures that policyholders can access their funds while still maintaining policy sustainability and compliance with contract terms","example":12,"format":"int32"},"totalYearToDateWithdrawalTaken":{"type":"number","description":"The Total YTD (Year-To-Date) Withdrawal Taken refers to the total amount withdrawn by the policyholder from their life insurance policy or annuity within the current contract year. This tracks all withdrawals made so far from the beginning of the policy year up to the present date.","example":0,"format":"double"},"numberOfWithdrawal":{"type":"number","description":"The Number of Withdrawals refers to the total count of withdrawal transactions made by the policyholder within a specified period, typically within the current policy year or calendar year. This tracks how frequently funds have been withdrawn from the policy","example":0,"format":"int32"},"withdrawalAllowedStartDate":{"type":"string","description":"The Withdrawal Allowed Start Date refers to the calculated date from which the policyholder is permitted to make withdrawals from the policy’s cash value or annuity funds. This date is determined based on policy terms, surrender charge periods, and regulatory restrictions","example":"2023-01-01","format":"date"},"remainingFreeWithdrawalAmount":{"type":"number","format":"double","description":"The remaining portion of the annual free withdrawal allowance that the policyholder can withdraw during the current contract year without incurring surrender charges or withdrawal penalties.","example":0}},"required":["yearToDateFreeWithdrawalAmount"]},"MarketValueAdjustment":{"type":"object","properties":{"marketValueAdjustmentIndicator":{"type":"boolean","description":"The MVA Indicator is a flag or marker that indicates whether a Market Value Adjustment (MVA) applies to an annuity or investment. This adjustment impacts the contract value when withdrawals or surrenders occur before the end of the contract’s term"},"marketValueAdjustmentAmount":{"type":"number","format":"double","description":"The MVA Adjustment refers to the Market Value Adjustment applied to an annuity contract when a withdrawal or surrender occurs before the end of the contract period. It adjusts the contract value based on changes in interest rates since the contract was issued.","example":12.42342},"marketValueAdjustmentPeriod":{"type":"number","format":"int32","example":1,"description":"MVA Period (Market Value Adjustment Period) refers to the specific timeframe during which a Market Value Adjustment (MVA) may be applied to withdrawals, surrenders, or transfers from a fixed or indexed annuity contract. This period typically aligns with the guaranteed interest rate period and is designed to account for interest rate fluctuations that affect the insurer’s investment value"},"marketValueAdjustmentBaseRate":{"type":"number","description":"The MVA Indicator is a flag or marker that indicates whether a Market Value Adjustment (MVA) applies to an annuity or investment. This adjustment impacts the contract value when withdrawals or surrenders occur before the end of the contract’s term.","example":12.42342,"format":"double"},"marketValueAdjustmentCapFloorAmount":{"type":"number","format":"double","description":"The maximum positive or negative adjustment amount allowed under the contracts Market Value Adjustment (MVA) provision, which limits the total increase or decrease applied to a withdrawal or surrender value due to interest rate changes.","example":12.42342},"marketValueAdjustmentCurrentRate":{"type":"number","format":"double","description":"The current reference interest rate used by the insurer when calculating the Market Value Adjustment (MVA) at the time of withdrawal, surrender, or transfer.","example":12.42342},"marketValueAdjustmentRateAtIssue":{"type":"number","format":"double","description":"The reference interest rate at the time the contract or segment was issued, which is used as the baseline for calculating the Market Value Adjustment (MVA) when comparing it to the current rate.","example":12.42342},"fractionalYearsRemainingInSurrenderChargePeriod":{"type":"number","format":"double","description":"The remaining portion of the surrender charge period, expressed as a fraction of a year, representing the time left before surrender charges no longer apply to the contract.","example":12.42342}}},"RequiredMinimumDistributionCalculationOption":{"type":"string","enum":["RULE2002","BENEFICIARYDISTRIBUTIONQUALIFIED","BENEFICIARYDISTRIBUTIONNONQUALIFIED","JOINTNONRECALCULATION1987","JOINTRECALCULATION1987","MANUALENTRY","SINGLENONRECALCULATION1987","SINGLERECALCULATION1987"]},"RequiredMinimumDistribution":{"type":"object","properties":{"totalRequiredMinimumDistributionAnnualAmount":{"type":"number","format":"double","description":"The Total RMD (Required Minimum Distribution) Annual Amount refers to the minimum amount that a policyholder must withdraw from their annuity or retirement account each year to avoid IRS penalties. This applies to tax-deferred retirement accounts once the account owner reaches the Required Beginning Date (RBD).","example":12.42342},"remainingRequiredMinimumDistributionAmount":{"type":"number","format":"double","description":"The Remaining RMD Amount refers to the amount of Required Minimum Distribution (RMD) that the policyholder still needs to withdraw before the end of the calendar year to avoid IRS penalties. It is calculated as the Total RMD Annual Amount minus any withdrawals already taken during the year","example":12.42342},"actuarialPresentValue":{"type":"number","format":"double","description":"The Actuarial Present Value (APV) Amount refers to the present value of future expected benefits or cash flows from a life insurance policy, annuity, or pension plan, discounted to the end of the year. It is used in actuarial calculations to estimate the current value of future liabilities or benefits, considering mortality rates, interest rates, and time value of money.","example":12.42342},"priorYearEndAccountValue":{"type":"number","format":"double","description":"The Prior Year-End Account Value refers to the total account value of a life insurance policy or annuity as of December 31 of the previous year. It represents the ending balance of the policy`s cash value or investment portion at the close of the prior year, before any transactions in the current year","example":12.42342},"requiredMinimumDistributionRecalculationDate":{"type":"string","format":"date","description":"The RMD Recalculation Date refers to the date when the Required Minimum Distribution (RMD) amount is automatically recalculated for qualified annuities and retirement contracts. This recalculation occurs annually, starting in the year after December 31 of the year the owner turns 69.5, and continues every year thereafter","example":"2023-01-01"},"requiredMinimumDistributionCalculationOption":{"$ref":"#/components/schemas/RequiredMinimumDistributionCalculationOption"},"priorCalendarYearRequiredMinimumDistributionAmount":{"type":"number","format":"double","description":"The Required Minimum Distribution (RMD) amount that was required to be withdrawn from the contract during the previous calendar year, as determined under applicable IRS life expectancy rules.","example":12.42342},"lifeExpectancyFactor":{"type":"number","format":"double","description":"The life expectancy divisor obtained from the applicable IRS life expectancy table, used to calculate the Required Minimum Distribution (RMD) amount for a given year.","example":12.42342}}},"DefinitionOfLifeInsurance":{"type":"string","enum":["GPT","CVAT"]},"GuidelinePremium":{"type":"object","properties":{"guidelinePremiumTestDate":{"type":"string","description":"The Guideline Premium Test (GPT) Date refers to the last date on which the policy was tested to ensure compliance with the IRS`s Guideline Premium Test (GPT) for life insurance policies. This test ensures that the policy maintains its tax-advantaged status as a life insurance contract and does not become a Modified Endowment Contract (MEC).","format":"date","example":"2023-01-01"},"definitionOfLifeInsurance":{"$ref":"#/components/schemas/DefinitionOfLifeInsurance"},"guidelineSinglePremium":{"type":"number","description":"The Guideline Single Premium (GSP) refers to the maximum single premium payment that can be made into a life insurance policy without violating the IRS`s Guideline Premium Test (GPT). It is used to ensure that the policy qualifies as life insurance and maintains its tax-advantaged status","format":"double","example":65068.27},"guidelineLevelPremium":{"type":"number","description":"The Guideline Level Premium (GLP) is the maximum level (annual or periodic) premium that can be paid into a life insurance policy while maintaining compliance with the IRS`s Guideline Premium Test (GPT). It ensures that the policy remains classified as life insurance and retains its tax-advantaged status","format":"double","example":4695.39},"guidelinePremiumLimit":{"type":"number","description":"The Guideline Premium Limit represents the remaining cumulative amount of premium that can be paid into a life insurance policy over its lifetime without violating the IRS’s Guideline Premium Test (GPT). It helps ensure the policy maintains its tax-advantaged status as life insurance under Section 7702 of the Internal Revenue Code","format":"double","example":4695.39},"guidelinePremiumLimitBreached":{"type":"boolean","description":"Indicates whether the policy has breached the guideline premium limit."},"amountExcessToGuideline":{"type":"number","description":"The Amount Excess to Guideline refers to the excess premium amount paid into a life insurance policy beyond the IRS-imposed limits under the Guideline Premium Test (GPT). This excess must be reimbursed or adjusted to ensure the policy maintains its tax-advantaged status and does not become a Modified Endowment Contract (MEC)","format":"double","example":0},"totalGuidelineLevelPremiumSinceIssue":{"type":"number","description":"The Total Guideline Level Premium (GLP) Since Issue refers to the cumulative sum of all guideline level premiums allowed from the policy’s issuance through the current policy anniversary date. It ensures that the policy remains compliant with the IRS Guideline Premium Test (GPT) and maintains its life insurance tax-advantaged status","format":"double","example":4695.39}}},"ModifiedEndowmentContract":{"type":"object","properties":{"modifiedEndowmentContractTestDate":{"type":"string","format":"date","description":"The MEC Test Date refers to the last date on which the life insurance policy was tested to determine whether it qualifies as a Modified Endowment Contract (MEC) under IRS regulations. This date is updated whenever a new MEC test is performed, ensuring the policy remains compliant with federal tax rules","example":"2023-01-01"},"amountExcessToModifiedEndowmentContract":{"type":"number","format":"double","description":"The Amount Excess to MEC refers to the excess premium amount paid into a life insurance policy beyond the IRS-imposed Modified Endowment Contract (MEC) limit. This excess must be reimbursed, adjusted, or restructured to prevent the policy from becoming a MEC, which would alter its tax treatment","example":0},"modifiedEndowmentContractStatusDate":{"type":"string","format":"date","description":"The MEC Status Date refers to the exact date when a life insurance policy is classified as a Modified Endowment Contract (MEC) or confirmed as non-MEC. This date is critical for determining how future withdrawals and policy loans will be taxed","example":"2023-01-01"},"modifiedEndowmentContractStatus":{"type":"boolean","description":"The MEC Status indicates whether a life insurance policy has been classified as a Modified Endowment Contract (MEC) under IRS regulations. This status determines the tax treatment of withdrawals, loans, and distributions from the policy"},"sevenPayTestBasis":{"type":"number","format":"double","description":"The 7-Pay Test Basis refers to the total cumulative premium paid into a life insurance policy during the first seven years (the 7-pay period), as measured against the IRS 7-Pay Test limit. This amount is used to determine whether the policy qualifies as a life insurance contract or is classified as a Modified Endowment Contract (MEC).","example":198},"sevenPayPremium":{"type":"number","format":"double","description":"The 7-Pay Premium refers to the maximum allowable premium that can be paid into a life insurance policy during the first seven years without triggering Modified Endowment Contract (MEC) status. It ensures that the policy remains a tax-advantaged life insurance contract rather than an investment vehicle","example":19807.51079},"sevenPayStartDate":{"type":"string","format":"date","description":"The 7-Pay Start Date / Material Change Date refers to the date when the 7-Pay Test period begins. This is initially set at policy issuance (matching the Policy Start Date) and resets whenever a material change occurs that affects the policy’s funding limits","example":"2023-01-01"},"sevenPayPeriod":{"type":"string","format":"date","description":"The 7-Pay Period refers to the time frame during which the policy must comply with the 7-Pay Test to avoid Modified Endowment Contract (MEC) status. It starts on the 7-Pay Start Date (initially set at policy issuance) and lasts for seven years. The 7-Pay Period Expiration Date is calculated as: 7-Pay Expiration Date=7-Pay Start Date+7 Years","example":"2030-01-01"},"sevenPayLimit":{"type":"number","format":"double","description":"The 7-Pay Limit refers to the maximum total premium that can be paid into a life insurance policy within the first seven years without triggering Modified Endowment Contract (MEC) status. It is the benchmark used in the 7-Pay Test to determine whether a policy remains a tax-advantaged life insurance contract","example":0},"yearInPeriod":{"type":"integer","format":"int32","description":"The Year in Period refers to the current year within the seven-year time frame of the 7-Pay Test. It is crucial because the 7-Pay Limit increases each year, and the test is updated annually to ensure the policy remains within IRS limits","example":0},"unnecessaryPremium":{"type":"number","format":"double","description":"The Unnecessary Premium refers to the amount of premium that exceeds the limit set by the Nonforfeiture Premium Test (NPT Test). If premium payments are higher than the NPT limit, this amount is flagged as unnecessary premium, which may need to be refunded, adjusted, or redirected","example":232.12}}},"TestValues":{"type":"object","properties":{"guidelinePremium":{"$ref":"#/components/schemas/GuidelinePremium"},"modifiedEndowmentContract":{"$ref":"#/components/schemas/ModifiedEndowmentContract"}}},"DeathBenefitOptionType":{"type":"string","enum":["LEVEL","INCREASING"]},"ClaimStatus":{"type":"string","enum":["APPROVED","NOTAPPROVED","PROCESSED"]},"ProofOfDeathReceived":{"type":"string","enum":["Yes","No"]},"DeathBenefit":{"type":"object","properties":{"deathBenefitOption":{"$ref":"#/components/schemas/DeathBenefitOptionType"},"deathBenefitOptionEffectiveDate":{"type":"string","description":"The Death Benefit Option Effective Date refers to the date when the selected death benefit option (Level, Increasing, or Return of Premium) officially takes effect in the policy. This date determines when the death benefit structure is set for payout upon the insured`s death","format":"date","example":"2023-01-01"},"deathBenefitOptionChangedEffectiveDate":{"type":"string","description":"The Change in Death Benefit Option (DBO) Effective Date refers to the date when a requested change in the death benefit option is processed and officially takes effect in the policy. This allows tracking of modifications between Level (Option A), Increasing (Option B), or Return of Premium (Option C) death benefit structures","format":"date","example":"2023-01-01"},"deemedDeathBenefit":{"type":"number","description":"Deemed Death Benefit refers to the minimum amount that must be considered the \"death benefit\" under an insurance contract as per IRS Section 7702(e)(1)(B). This is used for tax qualification purposes to ensure that a life insurance policy meets the statutory definition of life insurance (DLI) and retains its tax-advantaged status","example":12203.12,"format":"double"},"deathBenefitAgeGuarantee":{"type":"number","description":"The Death Benefit Age Guarantee refers to the age until which the policy guarantees a death benefit, provided certain conditions such as premium payments and policy requirements are met. This guarantee ensures that the death benefit remains in force up to a specified age, regardless of market performance or policy cash value fluctuations","format":"int32","example":63},"disputedDebtAmount":{"type":"number","description":"The Disputed Debt Amount refers to the total sum of all disbursement transactions processed on a life insurance policy between the insured`s Date of Death and the Date of Death Reported to the insurer. This amount may need to be reviewed and reconciled, as policy actions taken during this period may no longer be valid","format":"double","example":65068.27355},"deathBenefitInterest":{"type":"number","description":"The Death Benefit Interest refers to the interest accrued on the life insurance death benefit amount from the insured’s Date of Death until the payment is made to the beneficiary. This interest is typically required by state regulations and compensates for the delay between the insured’s death and the claim settlement","format":"double","example":150.12241},"deathBenefitIndexCredit":{"type":"number","description":"Partial index credit received as part of death benefit","format":"double","example":150.12241},"claimStatus":{"$ref":"#/components/schemas/ClaimStatus"},"proofOfDeathReceived":{"$ref":"#/components/schemas/ProofOfDeathReceived"},"remainingDeathBenefitPercentage":{"type":"number","description":"The percentage of the beneficiary`s allocated share of the death benefit that remains to be paid after the policyowners death.","format":"double","example":75.5}}},"RiskClass":{"type":"string","enum":["ULTRANONTOBACCO","ELITENONTOBACCO","PREFERREDNONTOBACCO","STANDARDNONTOBACCO","STANDARDTOBACCO","STANDARDAGGREGATE","SUBSTANDARDNONTOBACCO","SUBSTANDARDTOBACCO","STANDARDPLUSNONTOBACCO","PREFERREDTOBACCO","STANDARDCONVERSIONTOBACCO","STANDARDCONVERSIONNONTOBACCO"]},"SubStandardRating":{"type":"string","enum":["TABLEA","TABLEB","TABLEC","TABLED","TABLEE","TABLEF","TABLEG","TABLEH","TABLEI","TABLEJ","TABLEK","TABLEL","TABLEM","TABLEN","TABLEO","TABLEP","NONETABLE"]},"CoverageParticipants":{"type":"object","properties":{"partyId":{"type":"string","description":"The Insured(s) ID is a unique identifier assigned to the insured individual(s) covered under a life insurance policy. It is used by insurance companies to track, process, and manage policyholder records efficiently","example":"Party_PI_1"},"issueAge":{"type":"integer","format":"int32","description":"Note-Use coverage.coverageLayers.coverageParticipants.partyAgeAtIssue field instead of issueAge","example":43},"partyAgeAtIssue":{"type":"number","format":"int32","description":"The Party Age at Issue refers to the age of any party associated with a life insurance or annuity policy at the time the contract is issued","example":43},"riskClass":{"$ref":"#/components/schemas/RiskClass"},"substandardRating":{"$ref":"#/components/schemas/SubStandardRating"},"flatExtra":{"type":"array","items":{"$ref":"#/components/schemas/FlatExtra"}}}},"CoverageLayer":{"type":"object","properties":{"coverageId":{"type":"string","description":"The Coverage ID is a unique identifier assigned to a specific coverage type or benefit within an insurance policy. It helps insurance companies, agents, and policyholders track and differentiate multiple coverage components within a single policy","example":"Base_Coverage"},"coverageType":{"$ref":"#/components/schemas/RiderType"},"coverageName":{"type":"string","description":"The Coverage Name in a life insurance policy refers to the specific title or label assigned to a coverage type within the policy contract. It helps insurers, agents, and policyholders identify, classify, and manage different coverage components in a policy","example":"Base_Coverage"},"productCode":{"type":"string","description":"The Plan Code is a carrier-assigned alphanumeric identifier used to uniquely distinguish a specific insurance or annuity product, rate structure, version, and coverage layer within an insurer’s portfolio. It is essential for policy administration, pricing, underwriting, and claims processing","example":"EVGL1"},"coverageTerm":{"type":"number","format":"int32","description":"Coverage Term refers to the number of years that a life insurance policy or specific coverage component is intended to remain in force, providing protection to the insured. It defines the planned duration of insurance coverage, after which the coverage may expire, renew, or convert, depending on the product type","example":1},"approvedCoverageAmount":{"type":"number","description":"The Approved Coverage Amount refers to the specific amount of insurance coverage that has been approved by the insurer during the underwriting process. It represents the face amount (death benefit) the insurer has agreed to issue based on the applicant's risk profile, health, and other underwriting criteria","example":10000,"format":"double"},"currentAmount":{"type":"number","format":"double","description":"The Current Coverage Amount refers to the active or present death benefit or coverage value available under the policy at a specific point in time. It reflects any adjustments, policy changes, withdrawals, or loans that may have altered the original coverage amount","example":300000},"originalCoverageAmount":{"type":"number","format":"double","description":"The Original Coverage Amount refers to the initial face value or death benefit of a policy at the time of issuance before any policy modifications, withdrawals, loans, or benefit reductions. It represents the starting coverage amount agreed upon when the policy was first issued","example":300000},"minimumCoverageAmount":{"type":"number","format":"double","description":"The Minimum Coverage Amount at Each Coverage Level refers to the lowest permissible amount of insurance coverage allowed per policy layer, as set by the insurance carrier. It ensures policies remain financially viable and comply with regulatory and underwriting standards","example":10000},"maximumCoverageAmount":{"type":"number","format":"double","description":"The Maximum Coverage Amount at Each Coverage Level refers to the highest permissible amount of insurance coverage allowed per policy layer, as set by the insurance carrier","example":10000000},"grossDeathBenefitAmount":{"type":"number","format":"double","description":"The Gross Death Benefit per Coverage Layer refers to the total pre-deduction death benefit amount assigned to each specific coverage layer within a policy. It represents the sum of all base coverage amounts, riders, and enhancements before applying policy adjustments such as loans, withdrawals, or unpaid premiums","example":300000},"coverageTargetPremium":{"type":"number","format":"double","description":"Coverage Target Premium refers to the designated premium amount on a life insurance policy that:Qualifies for full target-level commissions in the first policy year, and Forms the basis for renewal commissions in subsequent policy years.Note - This is modal premium value","example":300000},"lowDeathBenefitAmount":{"type":"number","format":"double","description":"Low Death Benefit refers to the lowest possible death benefit guaranteed within each specific coverage component of a policy. This ensures that beneficiaries receive at least a minimum death benefit regardless of market performance, policy changes, or withdrawals","example":300000},"coverageChangeAmount":{"type":"number","format":"double","description":"The Coverage Change Amount refers to the specific increase or decrease in coverage that occurs within a life insurance policy due to policyholder requests, automatic adjustments, or insurer-initiated changes. This amount reflects the difference between the original or prior coverage amount and the new coverage amount after the change takes effect","example":3000000},"coverageEffectiveDate":{"type":"string","format":"date","description":"The Coverage Effective Date refers to the date when an increase in coverage or a new coverage component officially takes effect in a life insurance policy. It marks the beginning of the insured’s eligibility for the new or increased benefits","example":"2023-01-01"},"coverageChangeEffectiveDate":{"type":"string","format":"date","description":"The Coverage Change Effective Date (for a decrease in coverage) refers to the date when the reduced coverage amount officially takes effect in a life insurance policy. It marks the point from which the new lower coverage amount applies","example":"2023-01-01"},"coverageTerminationDate":{"type":"string","format":"date","description":"The Coverage Termination Date refers to the date when a policy’s coverage officially ends, meaning the insured is no longer protected under the contract. After this date, no benefits or claims can be paid unless reinstatement is an option","example":"2023-01-01"},"unitOfCoverage":{"type":"number","format":"double","description":"The Unit of Coverage refers to the measurement standard used to define the amount of coverage provided under a life insurance policy. It helps insurers calculate premiums, determine benefit payouts, and structure policies consistently.In life insurance, the unit of coverage is typically measured per $1,000 of face amount.","example":300},"valuePerUnitOfCoverage":{"type":"number","format":"double","description":"The Value per Unit of Coverage refers to the monetary worth of each unit of coverage in a life insurance policy, which is used for premium calculations, benefit payouts, and policy adjustments. This value helps insurers standardize pricing and policy structures.In life insurance, the value per unit represents the cost per $1,000 of coverage or payout per unit of death benefit.In annuities, it determines the payout per annuity unit or per $1,000 of account value","example":1000},"annualPremium":{"type":"number","format":"double","description":"The annual premium is the total amount you would pay for a full year of life insurance or annuity if you made just one payment per year","example":1000},"modalPremium":{"type":"number","format":"double","description":"Modal Premium refers to the actual premium amount a policyholder pays based on the selected billing frequency (mode)—such as monthly, quarterly, semiannual, or annual. It represents the current periodic payment due for the base coverage and any attached riders under a life or annuity insurance policy","example":1000},"cumulativeModalPremium":{"type":"number","format":"double","description":"Cumulative Modal Premium refers to the sum of actual premium amount a policyholder pays based on the selected billing frequency (mode)—such as monthly, quarterly, semiannual, or annual. It represents the sum of current periodic payment due for the base coverage and any attached riders under a life or annuity insurance policy.","example":1000},"guidelineSinglePremium":{"type":"number","format":"double","description":"The Guideline Single Premium (GSP) is the maximum single premium payment that can be made into a life insurance policy without causing it to lose its tax-advantaged status as life insurance under IRS guidelines. It is determined based on IRS regulations and ensures that the policy remains compliant with Section 7702 of the Internal Revenue Code","example":65068.27},"guidelineLevelPremium":{"type":"number","format":"double","description":"The Guideline Level Premium (GLP) is the maximum total premium that can be paid over time into a life insurance policy without violating IRS regulations under Section 7702. It ensures that a policy retains its tax-advantaged status as life insurance and does not become classified as a Modified Endowment Contract (MEC)","example":4695.39},"sevenPayPremium":{"type":"number","format":"double","description":"The 7-Pay Premium refers to the maximum cumulative premium that can be paid into a life insurance policy during the first seven years without causing the policy to become a Modified Endowment Contract (MEC). It is part of the 7-Pay Test, which ensures that life insurance policies do not become overfunded and lose their tax advantages","example":19807.51},"coverageParticipants":{"type":"array","items":{"$ref":"#/components/schemas/CoverageParticipants"}},"overdueModalPremium":{"type":"number","format":"double","description":"refers to a scheduled premium payment that was not received or applied by its due date, based on the policy’s modal frequency (e.g., monthly, quarterly, semi-annual, or annual). It represents a missed payment obligation that remains outstanding and may trigger administrative or policy-level actions","example":1000}},"required":["coverageTerm"]},"PolicyCoverage":{"type":"object","properties":{"totalCoverageAmount":{"type":"number","description":"The Total Coverage Amount refers to the maximum benefit or sum insured that a policyholder or beneficiary is entitled to receive under a life insurance contract. It represents the total financial protection provided by the policy","example":300000,"format":"double"},"cumulativeGrossDeathBenefitAmount":{"type":"number","description":"The Cumulative Gross Death Benefit refers to the total amount payable to a beneficiary upon the insured or annuitant death, before any deductions such as loans, outstanding premiums, or surrender charges. It represents the gross value of the death benefit provided under a life insurance or annuity contract. It is cumulative gross death benefit of all the layers of base coverage (not including riders ).","example":300000,"format":"double"},"netDeathBenefit":{"type":"number","description":"The Net Death Benefit refers to the actual amount paid to the beneficiary upon the insured or annuitant death, after deductions such as policy loans, unpaid premiums, withdrawals, or other charges","example":300000,"format":"double"},"remainingDeathBenefitAmount":{"type":"number","description":"The Remaining Death Benefit Amount refers to the portion of the death benefit that is still available as of date for benefit payment to beneficiaries after a partial claim has been taken","example":300000,"format":"double"},"minimumCoverageAmount":{"type":"number","description":"The Minimum Coverage Amount refers to the lowest amount of death benefit or policy coverage that an insurance company allows for a life insurance contract. It is the smallest sum insured that can be purchased under a specific product type","example":10000,"format":"double"},"maximumCoverageAmount":{"type":"number","description":"The Maximum Coverage Amount refers to the highest amount of death benefit or policy coverage that an insurance company will issue under a life insurance contract. It represents the largest sum insured that an applicant can qualify for based on underwriting and financial eligibility","example":10000000,"format":"double"},"coverageChangeEffectiveDate":{"type":"string","description":"The Earliest Coverage Change Date refers to the first possible date when a modification to an insurance policy can take effect. It defines the earliest point at which a policyholder can adjust coverage levels, add or remove riders, or make other contractual changes based on policy terms and conditions","example":"2023-01-01"},"coverageBand":{"type":"string","enum":["BAND1","BAND2","BAND3","BAND4","BAND5","BAND6","BAND7"],"description":"In life insurance, a band refers to a coverage range or tier that affects premium rates, underwriting guidelines, or policy benefits. Insurance companies use coverage bands to determine pricing structures, offering lower per-unit costs for higher coverage amounts"},"maximumAnnualCoverageChangeAllowedPerPolicy":{"type":"integer","description":"The Maximum Annual Coverage Change Allowed per Policy refers to the largest increase or decrease in coverage amount permitted within a single policy year, as defined by the insurance carrier. This limit is set to maintain policy stability, prevent excessive risk exposure, and ensure compliance with underwriting and policy guidelines","example":1,"format":"int32"},"minimumCoverageDecreaseAmount":{"type":"number","description":"The Minimum Coverage Amount Decrease refers to the smallest reduction in coverage that a policyholder is allowed to make per policy year, as defined by the insurance carrier. This ensures that policies remain viable and do not fall below the required minimum coverage limits","example":10000,"format":"double"},"maximumCoverageDecreaseAmount":{"type":"number","description":"The Maximum Coverage Amount Decrease refers to the largest reduction in coverage that a policyholder is allowed to make per policy year, as defined by the insurance carrier. This ensures that policyholders can lower coverage if needed while maintaining a minimum required coverage amount","example":290000,"format":"double"},"maximumAgeNumberCoverageAmountDecrease":{"type":"integer","description":"The Maximum Age of No Coverage Amount Decrease refers to the age at which a policyholder can no longer reduce their coverage amount. This limit is set by the insurance carrier to maintain policy integrity and ensure sufficient death benefit protection, particularly for older policyholders","example":80,"format":"int32"},"coverageAmountDecreaseAllowed":{"type":"integer","description":"The Number of Coverage Amount Decrease Allowed Per Policy Year refers to the maximum number of times a policyholder is permitted to reduce their coverage amount within a single policy year. This limit is set by the insurance carrier to maintain policy stability and prevent excessive policy modifications","example":120,"format":"int32"},"minimumCoverageIncreaseAmount":{"type":"number","description":"The Minimum Coverage Amount Increase refers to the smallest increment by which a policyholder can raise their coverage amount within a policy year. This minimum threshold is set by the insurance carrier to ensure that coverage increases are financially viable and align with underwriting guidelines","example":10000,"format":"double"},"maximumCoverageIncreaseAmount":{"type":"number","description":"The Maximum Coverage Amount Increase refers to the highest amount by which a policyholder can raise their coverage within a single policy year, as defined by the insurance carrier. This limit ensures that coverage increases remain manageable and are aligned with underwriting and financial justification","example":9700000,"format":"double"},"maximumAgeNumberCoverageAmountIncrease":{"type":"integer","description":"The Maximum Age of No Coverage Amount Increase refers to the oldest age at which a policyholder can request an increase in coverage. After reaching this age, the policyholder is no longer eligible to increase their coverage amount, as determined by the insurance carrier","example":80,"format":"int32"},"coverageAmountIncreaseAllowed":{"type":"integer","description":"The Number of Coverage Amount Increases Allowed Per Policy Year refers to the maximum number of times a policyholder can request an increase in coverage within a single policy year, as defined by the insurance carrier. This limit helps insurers manage risk exposure and maintain policy stability","example":10,"format":"int32"},"coverageLayers":{"type":"array","items":{"$ref":"#/components/schemas/CoverageLayer"}},"deathBenefitAmountDistributed":{"type":"number","description":"The amount of the death benefit that has been paid out. This should be the difference between of Cumulative Gross Death Benefit and Remaining Death Benefit Amount","example":250000,"format":"double"}}},"PolicyChargeType":{"type":"string","enum":["COSTOFINSURANCE","EXPENSECHARGE","UNITEXPENSECHARGE","PAYMENTCHARGE","COVERAGECHARGE","COVERAGECREDIT","PREMIUMTAX","SURRENDERCHARGE","MARKETVALUEADJUSTMENT","RIDERCHARGE"]},"PolicyCharges":{"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/PolicyChargeType"},"coverageId":{"type":"string","description":"The Coverage ID is a unique identifier assigned to a specific coverage component within a life insurance or annuity policy, used to track the specific coverage for which charges are being applied. It ensures that the correct charges (e.g., cost of insurance, rider fees, administrative fees) are linked to the appropriate coverage layer.This is optional field which will be populated by LPS","example":"Base_Coverage"},"currentMonthCharge":{"type":"number","description":"The Current Month Charge refers to the total amount deducted from a life insurance or annuity policy for the current billing period, covering various costs such as insurance charges, administrative fees, rider costs, and investment-related expenses","format":"double","example":123.12},"uncollectedPerCharge":{"type":"number","description":"The Uncollected Per Charge refers to the portion of a scheduled charge that has not been paid or deducted from the policy due to insufficient funds, unpaid premiums, or cash value shortfall. This can apply to Cost of Insurance (COI), rider fees, administrative charges, or investment-related expenses","format":"double","example":10.42},"cumulativePerCharge":{"type":"number","description":"The Cumulative Per Charge refers to the total sum of a specific charge type from the policy`s issue date until the current processing date. It provides a historical record of charges deducted over the life of the policy.. Calculated by LPS.","format":"double","example":721.42},"yearToDatePerCharge":{"type":"number","description":"It is the sum of charges in the current policy year","format":"double","example":721.42},"chargePercentage":{"type":"number","format":"double","example":12.42342,"description":"The percentage rate applied as a fee or charge under the contract for a specific transaction or benefit, such as a surrender charge, withdrawal charge, rider charge, or other applicable contract fee."}}},"ArrangementType":{"type":"string","enum":["PAYMENT","WITHDRAWAL","LOANREPAYMENT","REQUIREDMINIMUMDISTRIBUTION","PAYOUT","RIDERCLAIMWITHDRAWAL"]},"AllocationOption":{"type":"string","enum":["PRORATA","DOLLAR","SPECIFYPERCENTAGE","SPECIFIEDFUNDS","SPECIFIEDSEGMENTS","DEFAULT","PECKINGORDER","EARNINGSONLY","SPECIFICFUNDPERCENTAGE","FIXEDONLY","VARIABLEONLY","CURRENTHOLDINGS"]},"Reason":{"type":"string","enum":["PREMIUM","LOANREPAYMENT","FREEWITHDRAWALAMOUNT","WITHDRAWAL","ANNUITYPAYOUT","REQUIREDMINIMUMDISTRIBUTION"]},"DisbursementType":{"type":"string","enum":["GROSS","NET","NETNET"]},"PaymentForm":{"type":"string","enum":["DTCC","CREDITCARD","ACH","CHECK","WIRE","EXCHANGE","PREMIUMLOAN"]},"Frequency":{"type":"string","enum":["DAILY","EVERYTWOWEEKS","MONTHLY","SEMIANNUAL","QUARTERLY","ANNUAL","SINGLEPAYMENT"]},"AmountType":{"type":"string","enum":["AMOUNT","PERCENTAGE","MAX","FREEWITHDRAWALAMOUNT","WITHDRAWALUNTILBASIS","EARNINGSONLY","PRORATA","PERCENT","MODIFIEDEARNINGSONLY","SUNINCOMEMAXIMIZERONLYLBRMAXIMUM","SUNINCOMEMAXIMIZERNETONETIMEACCESS","NONSUNINCOMEMAXIMIZERLBRSWDMAXIMUM","SUNINCOMEMAXIMIZERGROSSONETIMEACCESS","YEARTODATEFIXEDEARNINGS","EARNINGSLIQUIDITYFIRST","EARNINGSLIQUIDITYLAST","GUARANTEEDWITHDRAWALBENEFIT","FIXEDMODIFIEDEARNINGS","ACCUMULATEDEARNINGS","LIFEEXPECTANCY","DEFAULT"]},"Party":{"type":"object","properties":{"partyRole":{"type":"string","enum":["PAYOR","PAYEE"],"description":"Note -Use systematicProgram.parties.partyRole field instead of systematicProgram.party.partyRole","example":"PAYOR"},"partyId":{"type":"string","description":"Note -Use systematicProgram.parties.partyId field instead of systematicProgram.party.partyId","example":"Party_PI_1"},"percentage":{"type":"number","description":"Note -Use systematicProgram.parties.percentage field instead of systematicProgram.party.percentage","example":10,"format":"double"},"bankId":{"type":"string","description":"Note -Use systematicProgram.parties.bankId field instead of systematicProgram.party.bankId","example":"Bank_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"}}},"SystematicProgramParties":{"type":"object","properties":{"partyRole":{"type":"string","enum":["PAYOR","PAYEE"],"description":"Role the program is tied to ( for example for money-in ,I could be owner or payor & for money-out it could be payee or beneficiary)","example":"PAYOR"},"partyId":{"type":"string","description":"Role ID of the party","example":"Party_PI_1"},"percentage":{"type":"number","example":10,"format":"double","description":"The party percentage for this program"},"bankId":{"type":"string","description":"Bank Account Tied to the Party","example":"Bank_1"},"addressId":{"type":"string","description":"Address Tied to the Party ID. In case of payment method Check , this field is required","example":"1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of FFC - For Further Credit(to notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"TBD"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."}}},"SystematicFundAllocation":{"type":"object","properties":{"allocationOption":{"$ref":"#/components/schemas/AllocationOption"},"amountType":{"$ref":"#/components/schemas/AmountType"}}},"FundDistributionSegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a particular segment for a specific fund account within the investment structure","example":"segment1"},"currentAmount":{"type":"number","description":"The current value of the particular segment for a specific fund account within the investment structure. The current amount of the segment, considering any earnings, withdrawals, or adjustments due to transaction","format":"double","example":1000},"requestedAmount":{"type":"number","format":"double","example":100,"description":"The specific amount or percentage requested for withdrawal, transfer, or reallocation from the particular segment selected for a fund.This amount will be utilized when allocation option is selected as specified segments"}}},"FundDistribution":{"type":"object","properties":{"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure","example":"FundAccount1"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure","example":"Fund1"},"totalFundValue":{"type":"number","description":"The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction","format":"double","example":100},"requestedAmount":{"type":"number","description":"The specific amount or percentage requested for withdrawal, transfer, or reallocation from the selected fund.This amount will be utilized when allocation option is selected as specified funds","format":"double","example":100},"fundDistributionSegments":{"type":"array","items":{"$ref":"#/components/schemas/FundDistributionSegment"}}}},"SystematicProgram":{"type":"object","properties":{"arrangementType":{"$ref":"#/components/schemas/ArrangementType"},"arrangementId":{"type":"string","description":"The unique payment number for payments by the party","example":"Arr_1"},"allocationOptionType":{"$ref":"#/components/schemas/AllocationOption"},"reason":{"$ref":"#/components/schemas/Reason"},"numberOfOccurrence":{"type":"number","description":"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,"format":"int32"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"status":{"$ref":"#/components/schemas/Status"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"frequency":{"$ref":"#/components/schemas/Frequency"},"requestedDate":{"type":"string","example":"2023-01-01","description":"The date on which the request for the systematic program was submitted","format":"date"},"startDate":{"type":"string","example":"2023-01-01","description":"The date when the systematic program begins executing payments or transfers (entered by user)","format":"date"},"endDate":{"type":"string","example":"2023-01-01","description":"The date Special Program ends (Entered by user or determined by LPS based on Account Value)","format":"date"},"previousProgramDate":{"type":"string","example":"2023-01-01","description":"The last date on which a systematic transaction was processed","format":"date"},"optedNextProgramDate":{"type":"string","example":"2023-01-01","format":"date","description":"A user-selected or modified next payment date, different from the scheduled one"},"nextProgramDate":{"type":"string","example":"2023-01-01","description":"The date on which the next payment is scheduled","format":"date"},"amountType":{"$ref":"#/components/schemas/AmountType"},"amount":{"type":"number","example":600,"format":"double","description":"A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program"},"party":{"description":"Note -Use systematicProgram.parties field instead of systematicProgram.party","type":"array","items":{"$ref":"#/components/schemas/Party"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/SystematicProgramParties"}},"externalArrangementId":{"type":"string","description":"The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program","example":"arrangementid123"},"fundAllocation":{"$ref":"#/components/schemas/SystematicFundAllocation"},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/FundDistribution"}}},"required":["externalArrangementId"]},"FeatureType":{"type":"string","enum":["FREELOOK","LAPSEASSESSMENT","LAPSEPROTECTION","REINSTATEMENT","RATELOCK","ANNUITIZATION","NONFORFEITUREOPTION","CONVERSION","BILLING","CUSTOMFEATURE","SURPLUSDISTRIBUTION"]},"PolicyFeature":{"type":"object","properties":{"featureType":{"$ref":"#/components/schemas/FeatureType"},"featureIndicator":{"type":"boolean","description":"A Feature Indicator in life insurance and annuities refers to a binary flag (Yes/No, True/False, or Enabled/Disabled) that signifies whether a specific policy feature, rider, or benefit is included in the contract. It helps insurers, agents, and policyholders quickly identify which optional or standard benefits apply to a policy"},"featureOption":{"type":"string","enum":["LIFEONLY","JOINTLIFEONLYJOINTANDSURVIVOR","PERIODCERTAIN","AMOUNTCERTAIN","LIFEWITHPERIODCERTAIN","LIFEWITHCASHREFUND","LIFEWITHINSTALLMENTREFUND","AUTOMATICPOLICYLOAN","REDUCEDPAIDUP","AGE","FACEAMOUNT","LEGAL","OPERATIONAL","COLLATERALLYASSIGNEDUNSPECIFIED","JOINTLIFEONLY","JOINTANDSURVIVOR","JOINTANDSURVIVORPERIODCERTAIN","DIVORCE","OVERPAYMENT","PAIDUPADDITION","CASH","MECRESTRICT","COMPLIANCE","JOINTLIFECASHREFUND","INTERESTONLY","JOINTLIFEINSTALLMENTREFUND"],"description":"A Feature Option in life insurance and annuities refers to the specific choices or variations available within a policy feature, allowing customization based on the policyholder’s needs"},"reducedPaidUpFaceAmount":{"type":"number","format":"double","description":"Reduced Paid-Up Face Amount is the new, lower death benefit that results when a policyholder elects the Reduced Paid-Up (RPU) insurance option on a permanent life insurance policy. Under this option, the policyholder uses the accumulated cash value of their policy to purchase a fully paid-up policy—meaning no further premiums are required—but with a reduced face amount compared to the original coverage","example":46.49},"startDate":{"type":"string","format":"date","example":"2023-01-01","description":"Start date of the feature"},"endDate":{"type":"string","format":"date","example":"2023-01-01","description":"End date of the feature"},"status":{"type":"boolean","description":"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"},"period":{"type":"number","format":"int32","description":"The Period of Feature in life insurance and annuities refers to the duration for which a specific feature or benefit is available, active, or applicable within a policy or contract. It defines the time frame in which a feature can be used, exercised, or remains valid","example":30},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Effective date of the feature"},"totalRequiredAmount":{"type":"number","format":"double","description":"The Total Minimum Required Amount refers to the lowest financial threshold needed to activate, maintain, or utilize a specific insurance or annuity feature. This can include minimum premiums, account balances, contributions, or fees necessary to keep the policy or benefit in force","example":0},"totalMinimumRequiredAmount":{"type":"number","format":"double","description":"Min (This is if Carrier Acceot Min) - This is the Amount needed to reactivate the Policy (If there is an Outstanding Loan on the Policy Min Required Loan Balance will be part of this Amount)","example":0},"paymentAmount":{"type":"number","format":"double","description":"The Payment Amount for a Feature refers to the specific cost required to activate, maintain, or utilize a particular policy feature or rider in a life insurance or annuity contract. This amount can be a one-time payment, recurring charge, or deducted from policy values depending on the feature type","example":46.49},"exclusionAmount":{"type":"number","format":"double","description":"The Fixed Exclusion Amount in the annuitization feature of an annuity refers to the portion of each annuity payment that is considered a return of the original investment (principal) and is therefore excluded from taxable income. This amount helps annuitants determine their tax liability on annuity payments","example":46.49},"yearToDatePaymentAmount":{"type":"number","format":"double","description":"The YTD Payment Amount for a Feature refers to the total amount paid or received for a specific policy feature from the beginning of the calendar year to the current date. This amount is commonly tracked for premiums, rider fees, annuity payouts, withdrawals, and other benefit-related transactions","example":46.49},"exclusionRatio":{"type":"number","format":"double","description":"The Exclusion Ratio in annuitization refers to the portion of each annuity payment that is considered a return of the original investment (principal) and is therefore excluded from taxable income. It determines how much of an annuity payment is taxable and how much is tax-free.","example":46.49},"totalPaymentAmount":{"type":"number","format":"double","description":"The Total Payment Amount of a Feature refers to the cumulative cost or sum of all payments made over time for a specific feature in a life insurance or annuity contract. This can include premiums, rider fees, annuity payouts, or benefit-related charges","example":46.49},"jointLivesPercentageToSurvivor":{"type":"number","format":"double","description":"Joint Lives % to Survivor refers to the percentage of annuity payments that continue to the surviving annuitant after one of the joint annuitants passes away. It applies to Joint & Survivor Annuities, ensuring ongoing income for the surviving spouse or beneficiary.","example":100},"underwritingDecision":{"type":"boolean","description":"The Reinstatement Underwriting Decision refers to the evaluation process and approval or denial of a reinstatement request for a lapsed life insurance policy or annuity contract. When a policy lapses due to non-payment, the insurer requires underwriting to determine if the policy can be reinstated based on financial, medical, and risk factors"},"approvalDate":{"type":"string","format":"date","example":"2023-01-01","description":"The Approval Date for a Feature refers to the official date on which an insurance company authorizes and activates a specific feature, rider, or benefit within a life insurance policy or annuity contract. This date marks when the feature becomes effective and available for use by the policyholder or annuitant"},"featureId":{"type":"string","example":"123","description":"Unique identifier of feature sub-type for \"custom feature"},"frequency":{"$ref":"#/components/schemas/Frequency"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"featureSubType":{"type":"string","enum":["MULTIPLEPOLICYDISCOUNT","CONTROLBUSINESSINDICATOR","RESTRICT","BROKERIDENTIFICATIONNUMBER"],"description":"Gives the sub type of the feature type \"Custom Feature"},"featureValue":{"type":"string","description":"The value of the feature","example":"123"},"periodCertainEndDate":{"type":"string","description":"The Period Certain End Date for a Feature refers to the final date of a specific feature or benefit within a life insurance or annuity contract. This date marks the end of the feature`s duration and defines when it ceases to be active or available for use by the policyholder or annuitant","example":"2023-01-01","format":"date"},"firstPaymentDate":{"type":"string","description":"The First Payment Date for a Feature refers to the initial payment date for a specific policy feature, rider, or benefit within a life insurance policy or annuity contract. This date marks when the feature becomes effective and available for use by the policyholder or annuitant","example":"2023-01-01","format":"date"},"annuitizedAmount":{"type":"number","description":"The base amount used to calculate annuity payouts, as determined during annuitization","format":"double","example":100000},"timestamp":{"type":"string","format":"date-time","example":"2023-01-01T12:00:00.000Z","description":"TBD"}}},"InvestmentType":{"type":"string","enum":["INVESTMENTFUND","INVESTMENTMODEL","CHARGEDEDUCTION","DEFAULTWITHDRAWAL","INTERESTRATERENEWAL"]},"FundAccountType":{"type":"string","enum":["FIXED","INDEXED","VARIABLE","INTERIM"]},"FundAllocation":{"type":"object","properties":{"fundId":{"type":"string","description":"A unique identifier for a specific fund account available for selection for Fund Allocation","example":"FUND001"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure","example":"Everglades Fixed IUL Fund"},"fundAccountType":{"$ref":"#/components/schemas/FundAccountType"},"allocationPercentage":{"type":"number","description":"The percentage of total fund allocation assigned to a particular fund account","example":100,"format":"double"},"startDate":{"type":"string","format":"date","description":"The date when the fund allocation /investment selection/fund becomes active","example":"2023-01-01"},"endDate":{"type":"string","format":"date","description":"The date when the fund allocation /investment selection/fund is no longer valid","example":"2023-01-01"}}},"Rate":{"type":"object","properties":{"rateType":{"type":"string","enum":["PARTICIPATION","CAP","SPREAD","TRIGGER","FLOOR","BONUS","GMIR","ILLUSTRATION","THRESHOLD","FUNDFEE","BAILOUT","BUFFER","COUPON","FIXED"],"description":"Rate Type identifies the classification of the rate that is being applied to a specific fund or account value within a life insurance or annuity policy. It defines how the interest, return, or crediting rate is determined for that fund.It helps dictate whether the rate is fixed, variable, index-linked, declared, or derived from another methodology, and plays a key role in calculating earnings or charges associated with the fund."},"currentRate":{"type":"number","format":"double","description":"Current Rate refers to the actual interest rate or crediting rate being applied to a specific fund or account at the present time, as declared or calculated by the insurance carrier. It is used to determine how much interest or investment return will be credited to the contract or sub-account during the current crediting period.","example":33.28},"initialGuaranteedRate":{"type":"number","format":"double","description":"The Initial Guaranteed Rate is the fixed interest rate promised by the insurance carrier at the start of the contract or fund allocation, which is guaranteed not to change for a specified initial period (e.g., 1, 3, 5, or 10 years), depending on the product terms.","example":33.28},"guaranteedMinimumRate":{"type":"number","format":"double","description":"The Guaranteed Minimum Rate is the lowest interest rate that an insurance company is legally or contractually obligated to credit to the account value or specific fund of a life insurance or annuity policy—regardless of market performance or declared rates. This rate acts as a floor, providing downside protection for the policyholder by ensuring a minimum return is always credited to the contract.","example":33.28},"guaranteedMaximumRate":{"type":"number","format":"double","description":"The Guaranteed Maximum Rate is the highest cap or participation rate that the insurer can declare, as specified in the contract. It does not represent an actual credited rate, but rather a ceiling to limit the insurer’s obligations. It works alongside guaranteed minimums and declared rates to balance customer upside potential with carrier risk management.","example":33.28},"rateEffectiveDate":{"type":"string","format":"date","description":"The date on which the rate becomes effective for the specific fund segment.","example":"2023-01-01"}}},"FundSegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a particular investment segment or bucket","example":"3"},"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure","example":"FundAccount1"},"originalDepositAmount":{"type":"number","description":"The initial amount deposited to the fund segment","format":"double","example":5.22},"originalDepositDate":{"type":"string","description":"The date on which the original deposit was deposited into the fund segment.(date the segment created)","format":"date","example":"2023-01-01"},"depositDate":{"type":"string","description":"The date on which the additional deposit was deposited into the fund segment","format":"date","example":"2023-01-01"},"depositAmount":{"type":"number","description":"The additional amount deposited to the fund segment","format":"double","example":5.22},"currentAmount":{"type":"number","description":"The value of the specific fund account segment, including all contributions, interest, and market changes","format":"double","example":161.81698},"renewalDate":{"type":"string","description":"The date on which the segment may be renewed or reinvested","format":"date","example":"2023-01-01"},"numberOfUnits":{"type":"number","description":"The number of units allocated in the fund segment (applicable to variable investments).","format":"int32","example":50},"sweepAccountId":{"type":"string","description":"The designated account where the segment funds will be transferred upon sweep,maturity","example":"EVGL002"},"interestEarningAmount":{"type":"number","format":"double","description":"This amount is used for Index interest calculation when Index crediting method is \"averaging\"","example":161.81698},"appliedInterestRate":{"type":"number","format":"double","description":"The interest rate used to calculate interest amount for segment as of the last transaction","example":161.81698},"startingPrice":{"type":"number","format":"double","description":"The initial market/index price or unit value when the segment was created","example":1234.21321},"startingPriceDate":{"type":"string","format":"date","description":"Date of Starting Price to be used for Index","example":"2023-01-01"},"endingPrice":{"type":"number","format":"double","description":"The market/index price or unit value when the segment was matures/ends","example":2000.81698},"endingPriceDate":{"type":"string","format":"date","description":"The date on which the ending price was determined","example":"2023-01-01"},"indexChangeRate":{"type":"number","format":"double","description":"The Index Change Rate refers to the rate of change in the value of an external market index (such as the S&P 500, Nasdaq, etc.) that is used to calculate interest credits for an indexed insurance or annuity product. It represents the percentage increase or decrease in the selected index over a defined crediting period, and directly influences the policy's credited interest or return.","example":2000.81698},"depositAnniversaryPrice":{"type":"number","format":"double","description":"The index value of the High Water Mark indexed fund segment as of the current contract anniversary date. This value represents the recorded index price used for interest crediting purposes on the anniversary.  Calculated and returned by LPS during the Anniversary transaction. Applicable only to High Water Mark indexed fund segments.  Updated on each Anniversary transaction to reflect the most recent anniversary index value.","example":100.5},"depositAnniversaryPriceDate":{"type":"string","format":"date","description":"The date corresponding to the anniversaryPrice value - representing the date on which the High Water Mark Index was recorded for the current contract anniversary. Always in sync with anniversaryPrice and updated together in the same Anniversary transaction","example":"2023-01-01"},"startDate":{"type":"string","description":"The date when the segment gets created","format":"date","example":"2023-01-01"},"endDate":{"type":"string","description":"The date when the segment matures/ends","format":"date","example":"2023-01-01"},"maxPrice":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility. Max Price = Max (IQ1, IQ2, IQ3, IQ4, …. IQN). where IQ1 denotes the index value at the 1st Quarterversary of the contract, IQ2 denotes the index value at the 2nd Quarterversary of the contract and so on and IQN denotes the index value at the end of the guarantee period (N=4*Guarantee period of the fund)","example":1234.21321},"maxPriceDate":{"type":"string","format":"date","description":"Deprecated - kept for backward compatibility. The corresponding date of the determined Quarterversary","example":"2023-01-01"},"rates":{"description":"Array of rates associated with this fund segment","type":"array","items":{"$ref":"#/components/schemas/Rate"}}}},"Fund":{"type":"object","properties":{"fundAccountType":{"$ref":"#/components/schemas/FundAccountType"},"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure","example":"EVGL002"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure","example":"S&P 500® Price Return Annual Point-to-Point with Participation Rate Account"},"generalLedgerFundCode":{"type":"string","description":"The accounting code used in the insurer’s general ledger for tracking fund transactions","example":"XE2"},"totalFundValue":{"type":"number","description":"The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction","format":"double","example":15.67},"percentageOfAccountValue":{"type":"number","description":"Percentage of Account Value refers to a value that is calculated as a percentage of the total account value of an insurance or annuity contract. It is often used to determine allocations, fees, benefits, or charges that are based on how much money is currently held in the policy's account value.","format":"double","example":13.27},"interestGuaranteedPeriod":{"type":"number","format":"int32","example":3,"description":"The length of time for which the guaranteed minimum interest rate is applicable"},"guaranteedMinimumInterestRate":{"type":"number","format":"double","example":1.52,"description":"Retrieving data. Wait a few seconds and try to cut or copy again"},"fundSegments":{"type":"array","items":{"$ref":"#/components/schemas/FundSegment"}}}},"MatchSegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"TBA unique identifier assigned to a specific match segment within the policy, used to track matched contributions or benefits","example":"Match1"},"matchAccountValue":{"type":"number","description":"The present value of the matched amount/bonus in the segment, reflecting any growth, deductions, or adjustments","format":"double","example":1.985116},"cumulativeMatchPaymentAmount":{"type":"number","description":"The total amount of matching contributions or eligible bonus contributions accumulated over time within the policy","format":"double","example":1.98},"yearToDateMatchValue":{"type":"number","description":"The amount of matching contributions or eligible bonus contributions accumulated over the current policy year","format":"double","example":1.98},"maximumLifeTimeVestingAmount":{"type":"number","description":"The highest total amount that can be matched or highest total eligible bonus over the lifetime of the policy, as per policy terms","format":"double","example":300},"maximumAnnualVestingAmount":{"type":"number","description":"The maximum amount that can be matched or eligible bonus for current policy year","format":"double","example":300},"minimumPaymentsForMatch":{"type":"number","description":"The minimum amount that can be matched or minimum eligible bonus over the lifetime of the policy, as per policy terms","format":"double","example":0},"unvestedPremiumBonus":{"type":"number","example":10.12,"description":"This is the current value that is not fully vested to the policy holder. It would be recaptured partially/fully at withdrawal/surrender.","format":"double"},"totalRecapturedPremiumBonus":{"type":"number","example":10.12,"description":"The total amount of the premium bonus that was deducted from the policy value as a result of a partial or full withdrawal during the vesting period.","format":"double"},"matchVestingDate":{"type":"string","description":"The date on which the matched amount/ bonus becomes fully vested, meaning the policyholder gains full ownership rights over the matched funds/bonus.(match amount/bonus becomes part of account value)","format":"date","example":"2023-01-01"},"generalLedgerFundCode":{"type":"string","description":"The accounting code used in the insurer’s general ledger system to track match/bonus related transactions","example":"V2201"},"vestingPeriod":{"type":"number","description":"The duration required before matched amount/bonus are fully vested, typically expressed in years or policy terms","format":"int32","example":10}}},"LoanType":{"type":"string","enum":["PREFERRED","NONPREFERREDSTANDARDLOAN","INDEXLOAN"]},"LoanSegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to each loan segment within the policy, representing a distinct loan transaction","example":"Loan1"},"loanType":{"$ref":"#/components/schemas/LoanType"},"loanInterestType":{"$ref":"#/components/schemas/LoanInterestType"},"loanInterestDue":{"type":"number","format":"double","description":"Calculated loan interest amount for a policy Owner to Pay before Anniversary","example":1000},"loanPrincipal":{"type":"number","format":"double","description":"The original amount borrowed against the policy, excluding interest","example":1500},"loanBalance":{"type":"number","format":"double","description":"The outstanding amount of the loan, including accrued interest if applicable","example":1500.72},"percentageOfAccountValue":{"type":"number","format":"double","description":"Percentage of Account Value refers to a value that is calculated as a percentage of the total account value of an insurance or annuity contract. It is often used to determine allocations, fees, benefits, or charges that are based on how much money is currently held in the policy's account value.","example":1500.72},"loanCollateralAmount":{"type":"number","format":"double","description":"This amount represents the total portion of the policy’s account value that is used as collateral when a loan is taken against the policy. It is calculated as follows:Loan Collateral Amount = Loan Principal + Loan Collateral Accrued Interest When a policyholder takes a loan, this amount reflects the loaned portion of the account value that is set aside as collateral. Interest is applied to this collateralized amount at a specific rate as per the policy terms","example":1500.72},"preInvestmentSegmentAmount":{"type":"number","format":"double","description":"TBD","example":0},"loanInterestRate":{"type":"number","format":"double","description":"The interest rate charged on the loan balance, which may be fixed or variable based on policy terms","example":4.5},"loanCreditRate":{"type":"number","format":"double","description":"The interest rate charged to any collateralized portion of the policy’s cash value","example":4},"loanAccruedInterest":{"type":"number","format":"double","description":"The interest accumulated on the outstanding loan balance that has not yet been paid","example":0.72},"loanCollateralAccruedInterest":{"type":"number","format":"double","description":"The interest accumulated on the collateral portion of account value.","example":0.16},"yearToDateLoanTaken":{"type":"number","format":"double","description":"The amount of loans taken against the policy in the current policy year","example":1500},"generalLedgerFundCode":{"type":"string","description":"The accounting code used in the insurer’s general ledger system to track loan fund","example":"V2201"},"startDate":{"type":"string","format":"date","description":"The date when the loan segment becomes active and enforceable within the policy","example":"2023-01-01"},"endDate":{"type":"string","format":"date","description":"The date when the loan segment is fully repaid, closed, or no longer applicable","example":"2023-01-01"}}},"SurplusDistributionOption":{"type":"string","description":"This is the Surplus Distribution type it can be PUA, Cash etc.","enum":["PAIDUPADDITION","CASH"]},"AllocationSurplusDistribution":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to each surplus distribution within the policy.","example":"s1"},"surplusDistributionOption":{"$ref":"#/components/schemas/SurplusDistributionOption"},"surplusDistributionAmount":{"type":"number","format":"double","description":"Surplus Distribution Amount that is calculated and credited.","example":1000},"currentCashValue":{"type":"number","format":"double","description":"Cash Value component for Paid-Up Addition purchased with Surplus Distribution.","example":1500},"paidUpAdditionCoverage":{"type":"number","format":"double","description":"Surplus Distribution buys small chunks of additional paid-up coverage. This is that coverage component.","example":1500.72}}},"Distribution":{"type":"object","properties":{"investmentType":{"$ref":"#/components/schemas/InvestmentType"},"modelName":{"type":"string","description":"Elect from available .. If Owner picks and Model as an investment option","example":"TBD"},"modelId":{"type":"string","description":"The corresponding Model Id of the elected model","example":"TBD"},"fundAllocationsInvestments":{"type":"array","items":{"$ref":"#/components/schemas/FundAllocation"}},"funds":{"type":"array","items":{"$ref":"#/components/schemas/Fund"}},"matchSegment":{"$ref":"#/components/schemas/MatchSegment"},"loanSegments":{"type":"array","items":{"$ref":"#/components/schemas/LoanSegment"}},"surplusDistributions":{"type":"array","items":{"$ref":"#/components/schemas/AllocationSurplusDistribution"}}}},"PolicySnapshotSurplusDistribution":{"type":"object","properties":{"surplusDistributionTotalAmount":{"type":"number","format":"double","description":"This is Cumulative Surplus Distribution Amount","example":1000},"totalPaidUpAdditionCashValue":{"type":"number","format":"double","description":"The total Cash Value of all the Paid-Up Additions that currently exist on the policy. This is the value available for surrender on the policy that is linked to the Paid-Up Additions purchased.","example":1500},"totalPaidUpAdditionCoverage":{"type":"number","format":"double","description":"The total coverage of all the Paid-Up Additions that currently exist on the policy. This is the value of the additional coverages that were purchased with the dividend as a Paid-Up Addition.","example":1500.72}}},"TrackerType":{"type":"string","enum":["ERRORTRACKER","PAUSEDTRACKER","TXLIFE","POLICYSTATETRACKER","LOCKEDTRACKER","REVERSALREQUEST","POLICYISSUANCEERROR"]},"PolicyContractState":{"type":"object","properties":{"trackerType":{"$ref":"#/components/schemas/TrackerType"},"status":{"type":"string","description":"The status of the policy contract, whether it is VALID or ERROR based on the trackerType that it's in.","example":"VALID"},"reason":{"type":"string","description":"The reason why this policy is in the current tracker state.","example":"Policy cannot be lifecycled to a previous date."},"currentLifecycleDate":{"type":"string","description":"The date the policy is currently lifecycled to.","format":"date","example":"2025-01-01"}}},"PartyRole":{"type":"string","enum":["OWNER","PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY","INSURED","PAYOR","PAYEE","AGENT","PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT","THIRDPARTYDESIGNEE","JOINTOWNER","COVERAGEINSURED","ASSIGNEE","ANNUITANT","EXCHANGECOMPANY","JOINTANNUITANT","GRANTOR","TRUSTEE","POWEROFATTORNEY","AUTHORIZEDSIGNATORY","OTHERINTERESTEDPARTY","CONTINGENTOWNER","THIRDPARTYADMINISTRATOR","CARRIER","SUCCESSORTRUSTEE","COVERAGEJOINTINSURED"]},"PowerOfAttorneyAccessLevelType":{"type":"string","enum":["FULLACCESS","LIMITEDACCESSFINANCIAL","LIMITEDACCESSNONFINANCIAL"]},"PolicyPartyRoles":{"type":"object","properties":{"partyRoleId":{"type":"string","example":"8","format":"int32","description":"The Party Role ID is a unique identifier assigned to a specific role that a party (individual or entity) plays within an insurance or annuity contract. It serves to distinctly track and manage the relationship between the party and the contract, especially when a party may have multiple roles across different policies or within the same policy"},"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","example":"Party_PI_1","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions"},"relationshipToInsured":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","LIFEPARTNER","MOTHER","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","GRANDPARENT","PARENT","OWNER","SIBLING","STEPCHILD","STEPARENT","OTHER","AUNT","GRANDFATHER","GRANDMOTHER","HUSBAND","WIFE","UNCLE","NIECE","NEPHEW","ESTATE","TRUST","GRANDSON","GRANDDAUGHTER","NONSPOUSE","CHILDRENEQUALLY","CHILDRENPERSTIRPES","PERSTIRPES","SURVIVINGSPOUS","COMORTGAGER","DEPENDENT"],"description":"The type of relationship to the party"},"relationshipToParty":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","LIFEPARTNER","MOTHER","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","GRANDPARENT","PARENT","OWNER","SIBLING","STEPCHILD","STEPARENT","OTHER","AUNT","GRANDFATHER","GRANDMOTHER","HUSBAND","WIFE","UNCLE","NIECE","NEPHEW","ESTATE","TRUST","GRANDSON","GRANDDAUGHTER","NONSPOUSE","CHILDRENEQUALLY","CHILDRENPERSTIRPES","PERSTIRPES","SURVIVINGSPOUS","COMORTGAGER","DEPENDENT"],"description":"The type of relationship to the party"},"startDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date the Party was added to the Policy"},"endDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date the Party was Terminated from the Policy"},"preferredCommunicationType":{"$ref":"#/components/schemas/CommunicationType"},"preferredAddressId":{"type":"string","example":"1","description":"Deprecated - kept for backward compatibility. Use preferredAddressId under party section. The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping"},"preferredEmailId":{"type":"string","example":"1","description":"Deprecated - kept for backward compatibility. Use preferredEmailId under party section. The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file"},"preferredPhoneId":{"type":"string","example":"1","description":"Deprecated - kept for backward compatibility. Use preferredPhoneId under party section. The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party"},"isAddressSameAsOwner":{"type":"boolean","description":"Boolean 0 = No 1 = Yes to denote if the email is the preferred"},"lastContactDate":{"type":"string","example":"2023-01-01","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","format":"date"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"Roles that are essential in structuring life insurance and annuity contracts to meet the financial goals of policyholders and beneficiaries."},"collateralAmount":{"type":"number","format":"double","description":"The Collateral Amount of an Assignee refers to the portion of a life insurance policy's value or benefit that is pledged as collateral to a third party (the assignee) under a collateral assignment agreement. This is commonly used when a policyholder uses a life insurance policy as security for a loan or other financial obligation.","example":1023.21},"powerOfAttorneyAccessLevelType":{"$ref":"#/components/schemas/PowerOfAttorneyAccessLevelType"},"partyPercentage":{"type":"number","format":"double","description":"Party Role Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties.","example":1023.21}}},"PartyType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","TRUST","INSURED"]},"AgentType":{"type":"string","enum":["ACCOUNTMANAGER","ADDITIONALCOMPENSATIONRECIPIENT","ADVANCEDUNDERWRITINGCONSULTANT","AGENCYORGENERALAGENT","AGENCYDIRECTOR","AGENCYSUPERINTENDENT","AGENCYVICEPRESIDENT","AGENTORPRODUCER","ASSISTANT","ASSISTANTGROUPUNDERWRITER","ASSISTANTMANAGER","ASSISTANTVICEPRESIDENT","ASSISTANTVPCOMPLIANCE","ASSOCIATEAGENCYMANAGER","ASSOCIATEFINANCIALPLANNER","ASSOCIATEOFFICERMANAGER","ASSOCIATESALEDEVELOPMENTMANAGERINTRAINING","ASSOCIATESALESDEVELOPMENTMANAGER","BANK","BANKEMPLOYEE","BRANCHMANAGER","BROKER","BROKERORDEALER","BROKERAGEDIRECTOR","BROKERAGEGENERALAGENT","CERTIFIEDFINANCIALPLANNER","DISTRIBUTOR","FINANCIALCONSULTANT","FINANCIALPLANNER","MANAGINGDIRECTOR","MANAGINGGENERALAGENT","OFFICEMANAGER","OTHER","PLATFORMREP","QUALIFYINGOFFICER","REGISTEREDFINANCIALPLANNER","REGISTEREDREPRESENTATIVE","SALESDEVELOPMENTMANAGER","SECONDLINEMANAGER","SENIORADMINISTRATIVECONSULTANT","SENIORADVANCEDUNDERWRITINGCONSULTANT","SENIORFINANCIALPLANNER","SENIORGROUPACCOUNTEXECUTIVE","SENIORGROUPSALESREPRESENTATIVE","SENIORPARTNER","SENIORSALESDEVELOPMENTMANAGER","SENIORVICEPRESIDENT","SERVICINGBROKER","SERVICINGONLYAGENT","SOLICITOR","TEAM","UNKNOWN"]},"Prefix":{"type":"string","enum":["MR","MS","MISS","MRS","DR"]},"Gender":{"type":"string","enum":["MALE","FEMALE","UNISEX"]},"TrustType":{"type":"string","enum":["INDIVIDUALTRUST","CORPORATETRUST","TESTAMENTARYTRUST","INTERVIVOSTRUST","GRANTORTRUST","PETTRUST"]},"PreferredCommunicationType":{"type":"string","enum":["EMAIL","REGULARMAIL","PHONE","FAX","TEXT","NOPREFERENCESPECIFIED","POSTAL","OTHER"]},"FormerName":{"type":"object","properties":{"firstName":{"type":"string","description":"Former first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"Former middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"Former last name of the party/trustee","example":"Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"fullName":{"type":"string","description":"Former full name of the party/Former legal name of the Trust/Organization","example":"Karen Anne Bates"},"abbreviatedName":{"type":"string","description":"The former shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"doingBusinessAs":{"type":"string","description":"The former name the organization is commonly known as","example":"TBD"}}},"TaxWithholdingType":{"type":"string","enum":["FEDERAL","STATE","NRA","BACKUP"]},"TaxRateToUse":{"type":"string","enum":["NOWITHHOLDINGELECTED","USEVALUESENTERED","NOWITHHOLDINGALLOWED","USEDEFAULTTABLE","ADDITIONALWITHHOLDING","TAKEINPUTTEDVALUE"]},"FilingStatus":{"type":"string","enum":["SINGLE","DOMESTICPARTNERSHIP","DEFAULT","MARRIED","HEADOFHOUSEHOLD","WIDOWED","DIVORCED","MARRIEDFILINGSEPARATELY"]},"Contribution":{"type":"string","enum":["NOTAPPLICABLE","EMPLOYEEVOLUNTARY","EMPLOYEEDISCRETIONARY"]},"TaxFormType":{"type":"string","enum":["T1035COSTBASIS","T1035LOANTRANSFER","T1035SURRENDER","T1035TAXADVANTAGE","T1099R","TAXDISCLOSUREFORMW4P","TAXDISCLOSUREFORMW8","USW4TAXFORM","W9","VOIDCHECK"]},"W4P":{"type":"object","properties":{"totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities":{"type":"number","format":"double","example":12.12,"description":"Below Amounts are for periodic Payments Only  - Certain States Require these amounts to be entered "},"totalAmountOfClaimsAndOtherCredits":{"type":"number","format":"double","example":213.73,"description":"This indicates the total amount of tax claims and credits party is eligible for to reduce the tax liabilities "},"otherIncome":{"type":"number","format":"double","example":144.53,"description":"Not from Jobs or Pension/Annuities "},"otherDeduction":{"type":"number","format":"double","example":42.83,"description":"If Standard Deduction is not used"}}},"TaxWithholding":{"type":"object","properties":{"appliesToPartyId":{"type":"string","description":"Party ID at Policy Level that comes in from External source (for Everly it will be Acord 103). This ties to the Party Type this tax withholding corresponds to.","example":"Party_PI_1"},"taxWithholdingType":{"$ref":"#/components/schemas/TaxWithholdingType"},"effectiveDate":{"type":"string","format":"date","example":"2024-01-01","description":"Date on which the tax withholding instruction becomes effective for the party."},"endDate":{"type":"string","format":"date","example":"2024-12-31","description":"Date on which the tax withholding instruction is no longer applicable for the party."},"taxRateToUse":{"$ref":"#/components/schemas/TaxRateToUse"},"filingStatus":{"$ref":"#/components/schemas/FilingStatus"},"dollar":{"type":"number","description":"The dollar amount of tax withheld","format":"double","example":0},"percentage":{"type":"number","description":"The percentage amount of tax withheld","format":"double","example":0},"exemptions":{"type":"number","description":"The total exemptions claimed for tax purposes","format":"int32","example":0},"taxJurisdiction":{"type":"string","description":"This is not input field i.e. user does not select or set this value. For Tax Withholding Type = State , DAML will set this value using PartyLevelAddressCountry_PartyLevelAddressState referring to ACCORD standard. For Tax Withholding Type = Federal , DAML will set this value using PartylevelAddressCountry using ACCORD standard.For FedeFor MVP, NRA jurisdictions are out of scope","example":"USA_WY"},"contribution":{"$ref":"#/components/schemas/Contribution"},"taxFormType":{"$ref":"#/components/schemas/TaxFormType"},"w4p":{"$ref":"#/components/schemas/W4P"}}},"PartyStatus":{"type":"string","enum":["APPROVED","NOTAPPROVED","PROCESSED"]},"DelegatedExecutionAuthorityType":{"type":"string","enum":["INDEPENDENT","TOGETHER","MAJORITY"]},"Parties":{"type":"object","properties":{"partyType":{"$ref":"#/components/schemas/PartyType"},"partyRoleId":{"type":"string","description":"TBD"},"parentPartyId":{"type":"string","description":"The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)","example":"1"},"beneficiaryPercentage":{"type":"number","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary","example":100,"format":"double"},"agentPercentage":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent","example":100},"agentExternalId":{"type":"string","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent","example":"3160000751"},"agentType":{"$ref":"#/components/schemas/AgentType"},"firstName":{"type":"string","description":"The first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"The middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"The last name of the party/trustee","example":"Bates"},"fullName":{"type":"string","description":"The full name of the party/The legal name of the Trust/Organization","example":"Karen Anne Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"gender":{"$ref":"#/components/schemas/Gender"},"dateOfBirth":{"type":"string","description":"The date of birth of the party","format":"date","example":"2023-01-01"},"genderIdentity":{"type":"string","description":"Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy","example":"TBD"},"attainedAge":{"type":"integer","description":"Age calculated by date of birth and Policy year","format":"int32","example":55},"birthCountry":{"$ref":"#/components/schemas/Country"},"citizenCountry":{"$ref":"#/components/schemas/Country"},"birthState":{"$ref":"#/components/schemas/State"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"TBD"},"entityType":{"$ref":"#/components/schemas/EntityType"},"trustDate":{"type":"string","description":"The trust agreement issued date to the party","format":"date","example":"2023-01-01"},"amendedTrustDate":{"type":"string","description":"The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy","format":"date","example":"2023-01-01"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"},"trustType":{"$ref":"#/components/schemas/TrustType"},"trustTitle":{"type":"string","description":"The title of the trustee","example":"TBD"},"trustAccessCode":{"type":"string","description":"Access code of the trustee","example":"TBD"},"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"preferredAddressId":{"type":"string","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping","example":"1"},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file","example":"1"},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"partyPercentage":{"type":"number","format":"double","description":"Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties","example":12.1213,"deprecated":true},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"taxWithholdings":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"},"isPartyBeneficiaryNonNatural":{"type":"boolean","description":"A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities"},"isIrrevocable":{"type":"boolean","description":"An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms"},"isRequiredMinimumDistributionDesignated":{"type":"boolean","description":"An indicator if the beneficiary is designated to be included in Joint RMD calculations"},"lastContactDate":{"type":"string","format":"date","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","example":"2023-01-01"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request."},"delegatedExecutionAuthorityType":{"$ref":"#/components/schemas/DelegatedExecutionAuthorityType"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"Party_PB_Primary_Bene_1"},"addresses":{"description":"Array of addresses associated with the party","type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"description":"Array of phone numbers associated with the party","type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"description":"Array of emails associated with the party","type":"array","items":{"$ref":"#/components/schemas/Email"}},"bankDetails":{"description":"Array of bank accounts associated with the party","type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"deathDetails":{"$ref":"#/components/schemas/DeathDetail"},"impairmentDetails":{"$ref":"#/components/schemas/ImpairmentDetails"},"timestamp":{"type":"string","format":"date-time","description":"TBD","example":"2023-01-01T12:00:00.000Z"},"customerId":{"type":"string","description":"Assigned by Sales Force and used by all platforms","example":"0017b000010N4bCAAS"},"insured":{"description":"Reference to the Insured model","allOf":[{"$ref":"#/components/schemas/Insured"}]},"version":{"type":"number","format":"int32","example":1}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"Internal ID of the snapshot document","example":"657bddcddc353e5fc5f45acd"},"event":{"type":"string","description":"The transaction type of the current policy snapshot","example":"InterestCreditMatch"},"effectiveDate":{"type":"string","format":"date","description":"Policy as of effective date (with pattern \"yyyy-mm-dd\").","example":"2023-01-01"},"carrierId":{"type":"string","description":"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":"EVGL"},"policyReferenceId":{"type":"string","description":"Attribute name storing the policy reference id generated by RDE system","example":"563f35b74b904f87a2e3ddbde0c3c541"},"thirdPartyAdministratorId":{"type":"string","description":"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"},"policySource":{"type":"string","description":"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"},"policySourceDescription":{"type":"string","description":"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"},"product":{"$ref":"#/components/schemas/Product"},"banding":{"type":"string","enum":["NOPREMIUMBANDING"],"description":"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"},"matchBonusVersion":{"type":"string","description":"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"},"packageId":{"type":"string","description":"Package Id identifies the investment package applicable to the policy, defining the funds and investment options available. The package is determined at the policy level and may change in response to policy events or configuration changes.","example":"1"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"Qualification type of original policy being exchanged"},"policyTerm":{"type":"number","format":"int32","description":"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},"policyYear":{"type":"number","format":"int32","description":"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},"monthOfYear":{"type":"number","format":"int32","description":"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},"policyNumber":{"type":"string","description":"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":"POLICY1234567890"},"parentPolicyNumber":{"type":"string","description":"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":"POLICY12345"},"priorPolicyNumber":{"type":"string","description":"The unique identifier of the original policy number of a policy in the case of a conversion, replacement, exchange or reissue","example":"POLICY123450"},"policyStatus":{"$ref":"#/components/schemas/PolicyStatus"},"restrictStatus":{"$ref":"#/components/schemas/RestrictStatus"},"issueType":{"$ref":"#/components/schemas/IssueType"},"issueState":{"$ref":"#/components/schemas/State"},"currency":{"$ref":"#/components/schemas/Currency"},"policyDates":{"$ref":"#/components/schemas/PolicyDates"},"costBasis":{"$ref":"#/components/schemas/CostBasis"},"fixedCostPeriod":{"type":"number","format":"int32","example":10,"description":"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"},"fixedCostPeriodOption":{"type":"number","format":"int64","description":"Option for fixed cost period calculation","example":1},"fixedCostPeriodUnit":{"$ref":"#/components/schemas/FixedCostPeriodUnit"},"fixedCostPolicyYearEnd":{"type":"number","format":"int32","example":2,"description":"This field will be calculated for each policy. If unit is Years, this field can be equal to Fixed Cost Period. If unit is AGE, then the calculation will be Fixed Cost Period minus Issue Age."},"fixedCostPeriodEndYear":{"type":"number","format":"int32","example":10,"description":"The calculated end year of the Fixed Cost Period. If fixedCostPeriodUnit is YEARS, this equals fixedCostPeriod. If fixedCostPeriodUnit is AGE, this is calculated as fixedCostPeriod minus Issue Age. This field is calculated by LPS for each policy."},"commissionOption":{"$ref":"#/components/schemas/CommissionOption"},"accountValues":{"$ref":"#/components/schemas/AccountValues"},"loanValues":{"$ref":"#/components/schemas/LoanValues"},"withdrawalValues":{"$ref":"#/components/schemas/WithdrawalValues"},"marketValueAdjustment":{"$ref":"#/components/schemas/MarketValueAdjustment"},"requiredMinimumDistribution":{"$ref":"#/components/schemas/RequiredMinimumDistribution"},"testValues":{"$ref":"#/components/schemas/TestValues"},"timestamp":{"type":"string","format":"date-time","example":"2023-01-01T12:00:00.000Z"},"deathBenefit":{"$ref":"#/components/schemas/DeathBenefit"},"coverage":{"$ref":"#/components/schemas/PolicyCoverage"},"riders":{"type":"array","items":{"$ref":"#/components/schemas/Rider"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/PolicyCharges"}},"systematicPrograms":{"type":"array","items":{"$ref":"#/components/schemas/SystematicProgram"}},"policyFeatures":{"type":"array","items":{"$ref":"#/components/schemas/PolicyFeature"}},"allocation":{"$ref":"#/components/schemas/Distribution"},"surplusDistribution":{"$ref":"#/components/schemas/PolicySnapshotSurplusDistribution"},"version":{"type":"integer","format":"int32","description":"Version number","example":1},"policyContractState":{"$ref":"#/components/schemas/PolicyContractState"},"partyRoles":{"description":"Array of party roles","type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"parties":{"description":"Array of parties","type":"array","items":{"$ref":"#/components/schemas/Parties"}}}},"TransactionStatus":{"type":"string","enum":["Pending","Completed","Failed","Reversed","Canceled","PendingReversal"]},"Outcome":{"type":"string","enum":["true","false"]},"DisbursementPaymentForm":{"type":"string","enum":["DTCC","EFT","ACH","CHECK","WIRE"]},"DeathBenefitInterestCalculatedFromDate":{"type":"string","enum":["DATEOFDEATH","DATEOFDEATHREPORTED"]},"ClaimCode":{"type":"string","enum":["DEATH","RIDER"]},"TransactionAmount":{"type":"object","properties":{"requestedAmount":{"type":"number","format":"double","example":100.41,"description":"Depending on the transaction, it will be one of the following: The amount requested for premium allocation or processing. The requested amount for issuing a new loan against the policy. The amount requested to initiate a loan repayment transaction. The requested amount for a partial withdrawal from the policy’s cash value. The requested amount for making adjustments to the policy’s value.This transaction overrides the value and do not adjust. Request amount shared for this variable will be utilized to override existing policy variable. Example: Cost basis change using value adjustment transaction, Old cost basis: $200, Value Adjustment Request Amount: $120, New Cost basis: $120."},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"loanType":{"$ref":"#/components/schemas/LoanType"},"loanInterestType":{"$ref":"#/components/schemas/LoanInterestType"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy number associated with a transaction for DTCC money movement."},"participantId":{"type":"string","example":"123456789","description":"The DTCC Participant ID (also known as a DTCC Number or Participant Number) is a unique identifier assigned by the Depository Trust & Clearing Corporation (DTCC) to financial institutions — such as broker-dealers, banks, or mutual funds — that participate in DTCC’s clearing and settlement systems."},"paymentAmount":{"type":"number","format":"double","description":"Depending on the transaction, it will be one of the following: The amount used for drafting requested premium amount. The amount used for drafting requested loan repayment amount","example":100.31},"appliedAmount":{"type":"number","format":"double","description":"Depending on the transaction, it will be one of the following: - The portion of the requested premium that was successfully applied to the account value of the policy. - The portion of the requested loan amount that was actually applied on the policy. - The portion of the requested loan repayment amount that was applied on the policy. - The portion of the requested withdrawal amount that was applied on the policy. - The total amount applied toward the full surrender of the policy. - The portion of a transaction applied amount that is summation of all fund level applied amounts impacted  due to the transaction. - The updated face amount successfully applied to the policy. - The amount refunded as part of a free-look period cancellation (policy cancellation within the allowable period). - The policy’s value before an adjustment is applied.","example":100.29},"freeAppliedAmount":{"type":"number","format":"double","description":"The portion of a transaction applied amount(e.g., withdrawal) that was processed without incurring charges or penalties","example":100.18},"calculatedAmount":{"type":"number","format":"double","description":"The system-determined premium amount based on policy calculations, this will be set as premium applied amount plus any applicable charges","example":100.19},"totalChargeAmount":{"type":"number","format":"double","description":"The total amount of fees or charges applied to the transaction which is summation of individual charges","example":100.41},"taxableAmount":{"type":"number","format":"double","description":"The portion of a transaction applied amount that is considered taxable based on IRS regulations","example":100.23},"deathClaimPayoutPreStateSpecificInterest":{"type":"number","format":"double","description":"The claim payout amount before applying Supplemental Security Income (SSI) offsets or adjustments","example":1000.91},"claimStatutoryInterestAmount":{"type":"number","format":"double","description":"The statutory interest amount paid as part of a claim settlement. This is the SSI amount","example":1000.41},"deathBenefitInterestCalculatedFromDate":{"$ref":"#/components/schemas/DeathBenefitInterestCalculatedFromDate"},"claimStatutoryInterestRate":{"type":"number","format":"double","description":"The state specific interest rate applied to the statutory claim payout","example":1000.51},"claimCode":{"$ref":"#/components/schemas/ClaimCode"},"distributionInternalRevenueServiceCode":{"type":"string","description":"The IRS tax reporting code associated to the distribution code","example":"LD"},"offageAmount":{"type":"number","description":"The difference between requested amount and applied amount for premium transactions","example":100.81,"format":"double"},"excessPremium":{"type":"number","description":"In transaction context, Excess Premium is the amount of premium applied beyond allowable or intended limits under a policy, triggering compliance review, refund, or corrective action","example":100.91,"format":"double"},"targetPremium":{"type":"number","description":"Target Premium is the planned annual premium amount set at issue for flexible premium policies. It serves as a benchmark for funding, performance monitoring, and commission purposes, but does not represent a required payment","example":100.19,"format":"double"},"netPaymentAmount":{"type":"number","description":"The net amount actually received from the agent to be applied to the policy","example":48000.28,"format":"double"},"retainedCommissionAmount":{"type":"number","description":"The difference between the net amount actually received and gross amount applied to the policy.","example":2000.29,"format":"double"},"premiumPortionAmount":{"type":"number","format":"double","example":1000.51,"description":"The amount paid toward the premium when the policy has a loan balance."},"loanRepaymentPortionAmount":{"type":"number","format":"double","example":1000.51,"description":"The amount paid toward the Loan Repayment when the policy has a loan balance."},"statutoryInterestCalculationFromDate":{"type":"string","format":"date","description":"The effective date from which statutory interest should begin to be calculated for the transaction","example":"2023-01-01"}}},"LineOfBusiness":{"type":"string","enum":["LIFE","ANNUITY","MUTUALFUND","CERTIFICATEOFDEPOSIT","BROKERAGE","OTHER"]},"TransactionExchange":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Exchange ID is a unique identifier assigned to a policy or transaction involved in an exchange or rollover process. It is used to track, reference, and reconcile activities related to the replacement, transfer, or conversion of funds or policies between contracts, products, or carriers.","example":"EX0000001"},"policyNumber":{"type":"string","description":"The original policy number involved in an exchange or replacement transaction.","example":"POLICY1234567890"},"exchangeDescription":{"type":"string","enum":["DEFAULT","EXTERNAL1035","INTERNAL1035","EXTERNALDIRECTTRANSFER","INTERNALDIRECTTRANSFER","EXTERNALROLLOVERQUALIFIED","INTERNALROLLOVERQUALIFIED","EXTERNALROTHROLLOVER","INTERNALROTHROLLOVER","EXTERNALROTHDIRECTTRANSFER","INTERNALROTHDIRECTTRANSFER","BENEFITPROCEEDS","CASHCONTRIBUTIONS","EXTERNAL1035PARTIAL","INTERNAL1035PARTIAL","BIRTHORADOPTIONREPAYMENT","INTERNALDIRECTTRANSFERREPLACEMENT","EXTERNALDIRECTTRANSFERREPLACEMENT","CLIENTINITIATEDTRANSFER","CONVERSION"],"description":"Description of the type of exchange such as External 1035, Internal 1035, etc"},"exchangeDate":{"type":"string","format":"date","description":"The date on which 1035 Exchange occurs","example":"2023-01-01"},"lineOfBusiness":{"$ref":"#/components/schemas/LineOfBusiness"},"exchangeAmount":{"type":"number","format":"double","description":"Amount received in 1035 Exchange ","example":161.81698},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"Qualification type of original policy being exchanged"},"costBasis":{"type":"number","format":"double","description":"Original cost basis of the policy being exchanged - previous Policy","example":161.81698},"modifiedEndowmentContractStatus":{"type":"boolean","description":"Indicates if the original policy being exchanged is classified as MEC"},"outstandingLoanRolloverAmount":{"type":"number","format":"double","description":"The amount of any outstanding loan against the original policy that will be rolled over into the new policy during the 1035 exchange","example":161.81698}},"required":["policyNumber"]},"TransactionChargeType":{"type":"string","enum":["COSTOFINSURANCE","EXPENSECHARGE","UNITEXPENSECHARGE","RIDERCHARGE","SURRENDERCHARGE","WITHDRAWALCHARGE","PAYMENTCHARGE","COVERAGECHARGE","COVERAGECREDIT","PREMIUMTAX","MARKETVALUEADJUSTMENT","BONUSRECAPTURE","EQUITYINDEXADJUSTMENT","PRODUCTLIMITS","DEATHBENEFITINTEREST","FUTURECHARGESFORTRANSACTION","REDEMPTIONFEE","MAILCHARGE","FUNDFEE","INEFFECT","ALL","OVERNIGHTMAIL","WIRE"]},"ChargeWaiverIndicator":{"type":"string","enum":["Yes","No"]},"TransactionCharge":{"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/TransactionChargeType"},"chargeWaiverIndicator":{"$ref":"#/components/schemas/ChargeWaiverIndicator"},"chargeWaiverReason":{"type":"string","description":"The reason why a charge was waived (e.g., Promotional Waiver, Policy Exception)","example":"100"},"partyId":{"type":"string","description":"The partyId to which the charge is applied.","example":"Party_PI_1"},"coverageId":{"type":"string","description":"The identifier of the specific coverage associated with the charge","example":"Base_Coverage"},"chargeAmount":{"type":"number","description":"The amount of the charge applied for this transaction","format":"double","example":100},"chargeAppliedRate":{"type":"number","description":"The rate (%) utilized for calculation of charge","format":"double","example":100}}},"CoverageBenefit":{"type":"object","properties":{"coverageId":{"type":"string","description":"Coverage ID is a unique system-generated identifier assigned to a specific coverage component within an insurance or annuity policy. It is used to track and differentiate each distinct benefit, rider, or coverage layer under a single contract, especially when performing or recording transactions","example":"Base_Coverage"},"netBenefitAmount":{"type":"number","description":"Net Benefit Amount refers to the actual amount payable to a beneficiary or policyholder after all applicable deductions have been applied to the gross or base benefit amount. It represents the final disbursed value for a given coverage benefit, such as a claim payout, death benefit, or living benefit","example":12345.67,"format":"double"},"grossBenefitAmount":{"type":"number","format":"double","example":12345.67,"description":"Gross Benefit Amount refers to the total contractual benefit payable under a specific coverage or rider before any deductions are applied. It represents the original, full value of the benefit promised by the insurance policy (e.g., death benefit, living benefit, or rider payout)."},"increaseInFaceAmount":{"type":"number","format":"double","example":12345.67,"description":"The amount by which a coverage's face amount is increased as a result of a Face Amount Change transaction (during face increase)."},"decreaseInFaceAmount":{"type":"number","format":"double","example":12345.67,"description":"The amount by which a coverage's face amount is decreased as a result of a Face Amount Change transaction (during face decrease)."}}},"PayoutType":{"type":"string","enum":["LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION"]},"PayoutInformation":{"type":"object","properties":{"payoutType":{"$ref":"#/components/schemas/PayoutType"}}},"TransactionFundAllocation":{"type":"object","properties":{"allocationOption":{"$ref":"#/components/schemas/AllocationOption"}}},"SegmentActivity":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a particular segment for a specific fund account within the investment structure","example":"segment1"},"appliedRate":{"type":"number","description":"For funds: The rate at which an activity (e.g., interest, withdrawal, allocation) is applied. For match: The percentage rate at which the match or bonus contribution current value grows. For loans: The interest rate applied to the loan balance to calculate accrued interest","format":"double","example":100},"appliedAmount":{"type":"number","description":"For funds: The specific amount or percentage applied for withdrawal, transfer, or reallocation from the particular segment selected for a fund. For match: This is transaction level amount which tracks changes to match current value. This gets calculated on events such as interest credit match, premium, match bonus vesting. For loans: This is transaction level amount which tracks changes to loan balance . This gets calculated on events such as interest loan,loan repayment, loan true up,new loan,etc.","format":"double","example":100},"appliedInterest":{"type":"number","description":"Applied Interest refers to the amount of loan interest that has been posted (charged) to the policy’s outstanding loan balance during a specific accounting period. This interest is based on the terms of the policy loan, such as the loan type (fixed or variable), rate, and method of interest","format":"double","example":100}}},"FundActivitySegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a particular segment for a specific fund account within the investment structure","example":"segment1"},"currentAmount":{"type":"number","description":"The current value of the particular segment for a specific fund account within the investment structure. The current amount of the segment, considering any earnings, withdrawals, or adjustments due to transaction","format":"double","example":100},"segmentActivity":{"$ref":"#/components/schemas/SegmentActivity"}}},"FundActivity":{"type":"object","properties":{"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure","example":"FundAccount1"},"fundName":{"type":"string","description":"The official business name of the fund account as designated by the financial institution or insurance provider. This name identifies the specific fund within the investment structure","example":"Fund Account 1"},"fundAccountType":{"type":"string","enum":["FIXED","INDEXED","VARIABLE"],"description":"Represents the classification of a fund based on its investment strategy/flexiblity,and structure. It defines how the fund is structured and managed, such as whether it focuses on equities, fixed income, or other investment categories"},"totalFundValue":{"type":"number","description":"The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction","format":"double"},"appliedAmount":{"type":"number","format":"double","description":"The total amount or percentage applied for withdrawal, transfer, or reallocation from the selected fund","example":100},"fundActivitySegments":{"type":"array","items":{"$ref":"#/components/schemas/FundActivitySegment"}}}},"MatchActivity":{"type":"object","properties":{"currentAmount":{"type":"number","description":"This is total value of bonus or match post transaction processing including interest. This value will be populated on transaction which impacts bonus calculations. For e.g. premium, match bonus vesting","example":100},"segmentActivity":{"$ref":"#/components/schemas/SegmentActivity"}}},"LoanActivitySegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a specific loan segment","example":"Segment1"},"loanBalance":{"type":"number","description":"The outstanding loan amount, including both principal and accrued interest at segment level","example":100,"format":"double"},"loanAccruedInterest":{"type":"number","description":"The accumulated interest on the outstanding loan balance at segment level","example":100,"format":"double"},"percentageOfAccountValue":{"type":"number","description":"Percentage of Account Value refers to a value that is calculated as a percentage of the total account value of an insurance or annuity contract. It is often used to determine allocations, fees, benefits, or charges that are based on how much money is currently held in the policy's account value.","example":1500.72,"format":"double"},"repaymentInterestAmount":{"type":"number","example":100,"format":"double","description":"Loan Interest Repaid with current Repayment Transaction"},"segmentActivity":{"$ref":"#/components/schemas/SegmentActivity"}}},"LoanActivity":{"type":"object","properties":{"totalLoanBalance":{"type":"number","example":100,"description":"The total outstanding loan amount, including both principal and accrued interest","format":"double"},"totalLoanAccruedInterest":{"type":"number","description":"The accumulated interest on the outstanding loan balance","example":100,"format":"double"},"repaymentInterestAmount":{"type":"number","example":100,"format":"double","description":"The amount of interest repaid as part of transaction. This gets calculated on events such as loan repayment, systematic loan repayment,etc"},"loanSegments":{"type":"array","items":{"$ref":"#/components/schemas/LoanActivitySegment"}}}},"TransactionTaxBasis":{"type":"object","properties":{"currentContributionAmount":{"type":"number","example":161.81698,"format":"double","description":"The contribution amount made toward the policy in the current tax year."},"currentTaxYear":{"type":"number","format":"int32","example":1,"description":"The tax year for which contributions are being recorded."},"priorContributionAmount":{"type":"number","format":"double","example":161.81698,"description":"The amount contributed in the previous tax year"},"priorTaxYear":{"type":"number","format":"int32","example":1,"description":"The tax year associated with the prior contribution amount"},"preTaxEquityAndFiscalResponsibilityActBasis":{"type":"number","format":"double","example":161.81698,"description":"The cost basis of the policy before the Tax Equity and Fiscal Responsibility Act (TEFRA) changes"},"postTaxEquityAndFiscalResponsibilityActBasis":{"type":"number","format":"double","example":161.81698,"description":"The cost basis of the policy after Tax Equity and Fiscal Responsibility Act (TEFRA) changes"},"postTechnicalAndMiscellaneousRevenueActAmount":{"type":"number","format":"double","example":161.81698,"description":"Deprecated - kept for backward compatibility. Applies to 403b Qual type"}}},"AdhocTaxWithholdingInstructions":{"type":"object","properties":{"appliesToPartyId":{"type":"string","description":"Party ID at Policy Level that comes in from External source (for Everly it will be Acord 103). This ties to the Party Type this tax withholding corresponds to.","example":"Party_PI_1"},"taxWithholdingType":{"$ref":"#/components/schemas/TaxWithholdingType"},"effectiveDate":{"type":"string","format":"date","example":"2024-01-01","description":"Date on which the tax withholding instruction becomes effective for the party."},"endDate":{"type":"string","format":"date","example":"2024-12-31","description":"Date on which the tax withholding instruction is no longer applicable for the party."},"taxRateToUse":{"$ref":"#/components/schemas/TaxRateToUse"},"filingStatus":{"$ref":"#/components/schemas/FilingStatus"},"dollar":{"type":"number","description":"The dollar amount of tax withheld","format":"double","example":0},"percentage":{"type":"number","description":"The percentage amount of tax withheld","format":"double","example":0},"exemptions":{"type":"number","description":"The total exemptions claimed for tax purposes","format":"int32","example":0},"taxJurisdiction":{"type":"string","description":"This is not input field i.e. user does not select or set this value. For Tax Withholding Type = State , DAML will set this value using PartyLevelAddressCountry_PartyLevelAddressState referring to ACCORD standard. For Tax Withholding Type = Federal , DAML will set this value using PartylevelAddressCountry using ACCORD standard.For FedeFor MVP, NRA jurisdictions are out of scope","example":"USA_WY"},"contribution":{"$ref":"#/components/schemas/Contribution"},"taxFormType":{"$ref":"#/components/schemas/TaxFormType"},"w4p":{"$ref":"#/components/schemas/W4P"},"partyRole":{"$ref":"#/components/schemas/PartyRole"}}},"TaxWithheldAmount":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","example":"Party_PI_1","description":"A unique identifier linking the party to the policy"},"taxWithholdingType":{"$ref":"#/components/schemas/TaxWithholdingType"},"withheldAmount":{"type":"number","format":"double","example":100,"description":"The actual dollar amount withheld for taxes"},"withheldTaxableAmount":{"type":"number","format":"double","example":100,"description":"The portion of the transaction amount eligible for taxation"},"taxableFlag":{"type":"boolean","description":"Indicates whether the transaction is taxable"},"appliedTaxRate":{"type":"number","format":"double","example":100,"description":"The actual tax rate used for withholding calculations"}}},"FeatureSubType":{"type":"string","enum":["MULTIPLEPOLICYDISCOUNT","CONTROLBUSINESSINDICATOR","RESTRICT","BROKERIDENTIFICATIONNUMBER"]},"TransactionFeature":{"type":"object","properties":{"featureType":{"$ref":"#/components/schemas/FeatureType"},"featureSubType":{"$ref":"#/components/schemas/FeatureSubType"},"featureIndicator":{"type":"boolean","description":"A Feature Indicator in life insurance and annuities refers to a binary flag (Yes/No, True/False, or Enabled/Disabled) that signifies whether a specific policy feature, rider, or benefit is included in the contract. It helps insurers, agents, and policyholders quickly identify which optional or standard benefits apply to a policy."}}},"TransactionPayor":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"bankId":{"type":"string","description":"A unique identifier for the bank associated with the payor","example":"Bank_1"}}},"TransactionPayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction"},"disbursementAmount":{"type":"number","description":"The actual dollar amount disbursed to the payee","example":20},"partyRole":{"$ref":"#/components/schemas/PartyRole"},"payeeGrossAmount":{"type":"number","example":20},"addressId":{"type":"string","example":"1","description":"A unique identifier for the address associated with the payee or policyholder"},"forBenefitOfOrForFurtherCredit":{"type":"string","example":"TBD","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)."},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."}},"required":["allocationPercentage"]},"ExternalIdentifiers":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"The unique payment reference number for all premium-related transactions by carrier"},"externalTransactionId":{"type":"string","description":"The unique ID to identify transaction on carrier side"},"externalArrangementId":{"type":"string","description":"The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program"}}},"SuppressionType":{"type":"string","description":"Specifies the category or type of suppression being applied to a transaction. It indicates what kind of suppression is in effect.","enum":["CORRESPONDENCE","TAX","DISBURSEMENT","COMMISSION"]},"Suppression":{"type":"object","properties":{"suppressionType":{"$ref":"#/components/schemas/SuppressionType"},"suppressionReason":{"type":"string","description":"Specifies the specific reason or justification for applying the suppression. It explains why the suppression was applied."}}},"Transaction":{"type":"object","properties":{"transactionId":{"type":"string","description":"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"},"originalTransactionId":{"type":"string","description":"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"},"partyPolicyChangeReferenceId":{"type":"string","example":"1","description":"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"},"partyPolicyNewReferenceId":{"type":"string","example":"1","description":"Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added"},"planCode":{"type":"string","description":"A code that represents the specific type of life insurance plan or annuity plan","example":"PLAN001"},"policyNumber":{"type":"string","description":"A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract","example":"POLICY1234567890"},"correlationId":{"type":"string","description":"The unique ID to track each transaction request across all systems","example":"5df63b47-54fc-4905-a8ff-e1c5f12e667d"},"parentId":{"type":"string","description":"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"},"transactionType":{"type":"string","enum":["Activation","AddOwner","AddressChange","AgentChange","AnnuitantChange","Anniversary","AnnualPolicyRefreshAndRecalculation","AssigneeChange","BankAccountChange","BeneficiaryChange","CalendarProcessing","CancelNoPremium","ClaimPayout","CommunicationPreferenceChange","ConversionActivation","CostOfInsurance","CoverageCharge","CoverageCredit","DeathClaim","DeliveryDateSetup","Disbursement","EmailChange","ExistingPartyNameChange","ExpenseCharge","FaceAmountChange","FaceAmountDecrease","FaceAmountIncrease","FeatureChange","ForceOut","FreeLookExpiration","FreeLookCancellation","FullSurrender","FundAllocationsChange","FundTransfer","GrantorChange","PaymentInitialPremium","IdentifierChange","InitialPremium","InterestCredit","InterestCreditLoan","InterestCreditMatch","InterestLoan","Issuance","Lapse","LapseAssessment","LoanAnniversaryTrueUp","LoanRepaymentOneTime","MatchBonusVesting","MultipleBeneficiaryChange","MultipleEmailChange","MultiplePayeeChange","MultipleAgentChange","MultipleOwnerChange","MultipleAnnuitantChange","MultiplePhoneNumberChange","NewLoan","NotificationOfDeathClaim","OneTimePremium","OwnerChange","PartialWithdrawalOneTime","PolicyDetailsChange","PayeeChange","PaymentExpiration","PaymentLoanRepaymentOneTime","PaymentOneTimePremium","PaymentSystematicLoanRepayment","PayorChange","PhoneNumberChange","RateRenewal","RemoveOwner","Rescission","PowerOfAttorneyChange","PreferredMailingAddressChange","Reinstatement","ReinstatementApproved","Reissuance","RequiredMinimumDistributionOneTime","SubsequentPayment","SubsequentPremium","Sweep","SystematicLoanRepayment","SystematicLoanRepaymentSetup","SystematicPartialWithdrawal","SystematicPartialWithdrawalSetup","SystematicRequiredMinimumDistribution","SystematicRequiredMinimumDistributionSetup","SystematicPaymentSetup","SystematicAnnuityPayout","SystematicAnnuityPayoutSetup","SystematicProgramUpdate","TPDChange","TrusteeChange","UnitExpenseCharge","ValueAdjustment","YearBeginningRefreshAndRecalculation","WithdrawnApplication","DollarCostAverage","ProcessingDate","ServiceCharge","TransferCharge","RiderAddition","Annuitization","AnnuityBenefitReduction","Reclassification","FlatExtraChange","Commutation","Dividend","DividendFeatureCharge","MarketTimerFee","InterimAnnualProcessing","HardshipWithdrawal","HardshipEnd","ResetBenefitAmounts","GuaranteedAccumulationBenefitPeriodEnd","GainLossChargeBack","SpousalContinuation","PeriodicCharge","DeathBenefitLockIn","RatchetLockIn","GrowthDeathBenefitLockIn","DateOfDeath","BenefitAmountAutoAdjustment","NotificationOfRiderClaimStart","LongTermCareBenefitStartStop","DailyRatchet","AnnuitizationAnniversary","DeclineFeeChange","GuaranteedWithdrawalBenefitPaymentLockIn","ExcessInterestCredit","LongTermCareWithdrawal","GuaranteedWithdrawalBenefitInterestAdjustment","InvestmentAdvisorFee","PayoutAmountChange","AdditionalBenefitStart","AdditionalBenefitEnd","RiderActivationAnniversary","AdditionalBenefitRenew","QualifiedPlanChange","AdvanceAnnuityPayment","PartialCommutation","GuaranteedIndexRates","BailoutRenewal","NonLifeAnnuitization","AdditionalBenefitReCertification","CostBasisReceived","FreeWithdrawalRecalculation","YearEndGain","LongTermCareCertificationDate","QuarterlyProcessing","BenefitBaseAdjustment","RiderBenefitBaseLockIn","GuaranteedDeathBenefitRollUpRenew","GuaranteedWithdrawalBenefitRollUpRenew","RiderCharge","LongTermCareFeeStartStop","LongTermCareAssessmentCharge","RoleBirthday","PendingUnclaimedProperty","PendingPartialUnclaimedProperty","LiquidatedUnclaimedProperty","SystematicRiderClaimWithdrawalSetup","SystematicRiderClaimWithdrawal","TaxWithholdingChange","MultipleTrusteeChange","MultiplePowerOfAttorneyChange","OtherInterestedPartyChange","MultipleAuthorizedSignatoryChange","AuthorizedSignatoryChange","ExchangeCompanyChange","BillingFeatureChange","GWBPhaseChange"],"description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc"},"systematicOrBillingChangeIndicator":{"type":"boolean","description":"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"},"requestDate":{"type":"string","description":"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","format":"date"},"effectiveDate":{"type":"string","description":"The date when the transaction takes effect on the policy or contract.","example":"2023-01-01","format":"date"},"processDate":{"type":"string","description":"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","format":"date"},"reversalDate":{"type":"string","description":"The date when a transaction is reversed in the system","format":"date","example":"2023-01-01"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"outcome":{"$ref":"#/components/schemas/Outcome"},"outcomeCode":{"type":"string","description":"A system-generated code that corresponds to the transaction outcome when transaction is cancelled","example":"true"},"outcomeCodeDescription":{"type":"string","description":"A detailed explanation of the outcome, providing context for why a transaction was cancelled","example":"precheck validations failed"},"transactionReason":{"type":"string","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","FACEINCREASECOVERAGE","MECAUTHORIZATION","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS","DATEOFDEATH","INITIALDEATHNOTIFICATION","PRODUCTDEFAULT","GWBRIDERDISBURSEMENT","GWBPHASECHANGE","PREMIUMLOAN","PAYMENTDUEDATE"],"description":"The justification or business reason for the transaction"},"transactionAmounts":{"$ref":"#/components/schemas/TransactionAmount"},"exchange":{"$ref":"#/components/schemas/TransactionExchange"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/TransactionCharge"}},"coverageBenefit":{"type":"array","items":{"$ref":"#/components/schemas/CoverageBenefit"}},"payoutInformation":{"$ref":"#/components/schemas/PayoutInformation"},"fundAllocation":{"$ref":"#/components/schemas/TransactionFundAllocation"},"fundDistributions":{"$ref":"#/components/schemas/FundDistribution"},"fundActivities":{"$ref":"#/components/schemas/FundActivity"},"matchActivity":{"$ref":"#/components/schemas/MatchActivity"},"loanActivity":{"$ref":"#/components/schemas/LoanActivity"},"taxBasis":{"$ref":"#/components/schemas/TransactionTaxBasis"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithheldAmount"}},"features":{"type":"array","items":{"$ref":"#/components/schemas/TransactionFeature"}},"featureOption":{"type":"string","enum":["LIFEONLY","JOINTLIFEONLYJOINTANDSURVIVOR","PERIODCERTAIN","AMOUNTCERTAIN","LIFEWITHPERIODCERTAIN","LIFEWITHCASHREFUND","LIFEWITHINSTALLMENTREFUND","AUTOMATICPOLICYLOAN","REDUCEDPAIDUP","AGE","FACEAMOUNT","LEGAL","OPERATIONAL","COLLATERALLYASSIGNEDUNSPECIFIED","JOINTLIFEONLY","JOINTANDSURVIVOR","JOINTANDSURVIVORPERIODCERTAIN","DIVORCE","OVERPAYMENT","PAIDUPADDITION","CASH","MECRESTRICT","COMPLIANCE","JOINTLIFECASHREFUND","INTERESTONLY","JOINTLIFEINSTALLMENTREFUND"]},"payors":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPayor"}},"payeeOrBeneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/TransactionPayeeOrBeneficiary"}},"caseId":{"type":"string","description":"A unique identifier assigned to a transaction case by external systems such as BPM.","example":"e2eb325f-203b-4d49-b6d5-41072cb66866"},"partyId":{"type":"string","description":"The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)","example":"Party_PI_1"},"timestamp":{"type":"string","description":"Create or Update timestamp of transaction event","example":"2023-01-01T12:00:00.000Z"},"reverseInitiator":{"type":"boolean","default":false,"description":"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.","example":true},"version":{"type":"integer","description":"Version number indicating the number of changes made to policy","example":1,"format":"int32"},"externalIdentifiers":{"$ref":"#/components/schemas/ExternalIdentifiers"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"Delta":{"type":"object","properties":{"policyModelPath":{"type":"string"},"ledgerPath":{"type":"string"},"oldVal":{"type":"object"},"newVal":{"type":"object"}},"required":["policyModelPath","ledgerPath","oldVal","newVal"]},"TransactionDelta":{"type":"object","properties":{"id":{"type":"string"},"policyDetailsId":{"type":"string"},"ledgerDocId":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"policyNumber":{"type":"string"},"deltaValues":{"type":"array","items":{"$ref":"#/components/schemas/Delta"}},"version":{"type":"number"}},"required":["id","policyDetailsId","ledgerDocId","timestamp","policyNumber","deltaValues","version"]},"PolicyPartyResponse":{"type":"object","properties":{"partyType":{"$ref":"#/components/schemas/PartyType"},"partyRoleId":{"type":"string","description":"TBD"},"parentPartyId":{"type":"string","description":"The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)","example":"1"},"beneficiaryPercentage":{"type":"number","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary","example":100,"format":"double"},"agentPercentage":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent","example":100},"agentExternalId":{"type":"string","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent","example":"3160000751"},"agentType":{"$ref":"#/components/schemas/AgentType"},"firstName":{"type":"string","description":"The first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"The middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"The last name of the party/trustee","example":"Bates"},"fullName":{"type":"string","description":"The full name of the party/The legal name of the Trust/Organization","example":"Karen Anne Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"gender":{"$ref":"#/components/schemas/Gender"},"dateOfBirth":{"type":"string","description":"The date of birth of the party","format":"date","example":"2023-01-01"},"genderIdentity":{"type":"string","description":"Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy","example":"TBD"},"attainedAge":{"type":"integer","description":"Age calculated by date of birth and Policy year","format":"int32","example":55},"birthCountry":{"$ref":"#/components/schemas/Country"},"citizenCountry":{"$ref":"#/components/schemas/Country"},"birthState":{"$ref":"#/components/schemas/State"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"TBD"},"entityType":{"$ref":"#/components/schemas/EntityType"},"trustDate":{"type":"string","description":"The trust agreement issued date to the party","format":"date","example":"2023-01-01"},"amendedTrustDate":{"type":"string","description":"The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy","format":"date","example":"2023-01-01"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"},"trustType":{"$ref":"#/components/schemas/TrustType"},"trustTitle":{"type":"string","description":"The title of the trustee","example":"TBD"},"trustAccessCode":{"type":"string","description":"Access code of the trustee","example":"TBD"},"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"preferredAddressId":{"type":"string","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping","example":"1"},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file","example":"1"},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"partyPercentage":{"type":"number","format":"double","description":"Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties","example":12.1213,"deprecated":true},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"taxWithholdings":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"},"isPartyBeneficiaryNonNatural":{"type":"boolean","description":"A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities"},"isIrrevocable":{"type":"boolean","description":"An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms"},"isRequiredMinimumDistributionDesignated":{"type":"boolean","description":"An indicator if the beneficiary is designated to be included in Joint RMD calculations"},"lastContactDate":{"type":"string","format":"date","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","example":"2023-01-01"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request."},"delegatedExecutionAuthorityType":{"$ref":"#/components/schemas/DelegatedExecutionAuthorityType"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"Party_PB_Primary_Bene_1"},"addresses":{"description":"Array of addresses associated with the party","type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"description":"Array of phone numbers associated with the party","type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"description":"Array of emails associated with the party","type":"array","items":{"$ref":"#/components/schemas/Email"}},"bankDetails":{"description":"Array of bank accounts associated with the party","type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"deathDetails":{"$ref":"#/components/schemas/DeathDetail"},"impairmentDetails":{"$ref":"#/components/schemas/ImpairmentDetails"},"timestamp":{"type":"string","description":"TBD","example":"2023-01-01T12:00:00.000Z","format":"date-time"},"policyNumber":{"type":"string","description":"Policy number","example":"POLICY1234567890"},"customerId":{"type":"string","description":"TBD","example":"0017b000010N4bCAAS"},"insured":{"$ref":"#/components/schemas/Insured"},"version":{"type":"number","example":1,"format":"int32"}},"required":["timestamp","policyNumber","customerId","insured","version"]},"AddressBase":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of the party address. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"endDate":{"type":"string","description":"The end date of the party address. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01"},"addressType":{"$ref":"#/components/schemas/AddressType"},"addressLine1":{"type":"string","description":"Address Line 1 of the party address","example":"1112 Pickle Street"},"addressLine2":{"type":"string","description":"Address Line 2 of the party address","example":"South Jersey"},"addressLine3":{"type":"string","description":"Address Line 3 of the party address","example":"1234 Post box"},"city":{"type":"string","description":"City of the party address","example":"Garden City"},"state":{"$ref":"#/components/schemas/State"},"zipCode":{"type":"string","description":"Zip code of the party address","example":"67846"},"zipCodeExtension":{"type":"string","description":"Unit of the party address","example":"23"},"country":{"$ref":"#/components/schemas/Country"},"isPreferred":{"type":"boolean","description":"TBD"}}},"PhoneBase":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of when the party can be reached via the phone.Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"The end date of when the party can be reached via the phone. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"phoneType":{"$ref":"#/components/schemas/PhoneType"},"countryCode":{"type":"string","description":"Country Code of the phone","example":"9"},"areaCode":{"type":"string","description":"Area code of the phone","example":"973"},"dialNumber":{"type":"string","description":"Dial number of the phone","example":"765789"},"extension":{"type":"string","description":"Dial in Extension for phone","example":"null"},"bestTime":{"type":"string","description":"The best time to contact the party via phone","example":"null"},"timezone":{"type":"string","description":"Timezone for the entered phone details","example":"null"},"isPreferred":{"type":"boolean","description":"The Preferred Phone Indicator is a boolean flag or attribute assigned to each phone number associated with a party, used to identify which phone number should be used as the primary contact number for communication"}}},"EmailBase":{"type":"object","properties":{"startDate":{"type":"string","description":"The start date of when the party can be reached via email.Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"The end date of when the party can be reached via email. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"emailType":{"$ref":"#/components/schemas/EmailType"},"emailAddress":{"type":"string","description":"Email address of the party","example":"user@example.com"},"isPreferred":{"type":"boolean","description":"The Preferred Email Indicator is a boolean flag associated with each email address linked to a party, used to designate which email address should be treated as the primary contact for electronic communications"}}},"BankAccountBase":{"type":"object","properties":{"startDate":{"type":"string","description":"Date the Bank Account of the Party was added to the Policy. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"Date the Bank Account of the Party was terminated from the Policy. Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"nameOnAccount":{"type":"string","description":"Name of the Party on Bank Account","example":"abcdqwe"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"accountType":{"$ref":"#/components/schemas/AccountType"},"bankAccountPurpose":{"$ref":"#/components/schemas/BankAccountPurpose"},"accountNumber":{"type":"string","description":"The 7+ digit checking or savings account number","example":"34567777745678"},"routingNumber":{"type":"string","description":"The 9-digit routing transit number for the bank account/branch","example":"123456789"},"internationalBankAccountNumber":{"type":"string","description":"The bank account number for an international bank account (this field does not have check-digit validation)","example":"ibanNumber_66"},"branchName":{"type":"string","description":"The name of the bank (such as Chase Manhattan)","example":"branch_66"},"branchPhoneNumber":{"type":"string","description":"Phone Number of the Bank Branch","example":"7766667777"},"branchAddress":{"$ref":"#/components/schemas/BranchAddress"}}},"PartyAllocation":{"type":"object","properties":{"partyPolicyId":{"type":"string","description":"Party Policy ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions"},"allocationPercentage":{"type":"number","format":"double"}}},"PartyPatchRequestParty":{"type":"object","properties":{"partyType":{"$ref":"#/components/schemas/PartyType"},"partyRoleId":{"type":"string","description":"TBD"},"parentPartyId":{"type":"string","description":"The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)","example":"1"},"beneficiaryPercentage":{"type":"number","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary","example":100,"format":"double"},"agentPercentage":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent","example":100},"agentExternalId":{"type":"string","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent","example":"3160000751"},"agentType":{"$ref":"#/components/schemas/AgentType"},"firstName":{"type":"string","description":"The first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"The middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"The last name of the party/trustee","example":"Bates"},"fullName":{"type":"string","description":"The full name of the party/The legal name of the Trust/Organization","example":"Karen Anne Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"gender":{"$ref":"#/components/schemas/Gender"},"dateOfBirth":{"type":"string","description":"The date of birth of the party","format":"date","example":"2023-01-01"},"genderIdentity":{"type":"string","description":"Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy","example":"TBD"},"attainedAge":{"type":"integer","description":"Age calculated by date of birth and Policy year","format":"int32","example":55},"birthCountry":{"$ref":"#/components/schemas/Country"},"citizenCountry":{"$ref":"#/components/schemas/Country"},"birthState":{"$ref":"#/components/schemas/State"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"TBD"},"entityType":{"$ref":"#/components/schemas/EntityType"},"trustDate":{"type":"string","description":"The trust agreement issued date to the party","format":"date","example":"2023-01-01"},"amendedTrustDate":{"type":"string","description":"The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy","format":"date","example":"2023-01-01"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"},"trustType":{"$ref":"#/components/schemas/TrustType"},"trustTitle":{"type":"string","description":"The title of the trustee","example":"TBD"},"trustAccessCode":{"type":"string","description":"Access code of the trustee","example":"TBD"},"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"preferredAddressId":{"type":"string","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping","example":"1"},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file","example":"1"},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"partyPercentage":{"type":"number","format":"double","description":"Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties","example":12.1213,"deprecated":true},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"taxWithholdings":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"},"isPartyBeneficiaryNonNatural":{"type":"boolean","description":"A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities"},"isIrrevocable":{"type":"boolean","description":"An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms"},"isRequiredMinimumDistributionDesignated":{"type":"boolean","description":"An indicator if the beneficiary is designated to be included in Joint RMD calculations"},"lastContactDate":{"type":"string","format":"date","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","example":"2023-01-01"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request."},"delegatedExecutionAuthorityType":{"$ref":"#/components/schemas/DelegatedExecutionAuthorityType"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressBase"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/PhoneBase"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailBase"}},"bankDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountBase"}},"startDate":{"type":"string","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"beneficiaryAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}},"partyAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}}}},"PartyPatchRequestPartyUpdate":{"type":"object","properties":{"action":{"type":"string","enum":["ADD","UPDATE","DELETE"]},"partyRole":{"type":"string","enum":["OWNER","PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY","INSURED","PAYOR","PAYEE","AGENT","PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT","THIRDPARTYDESIGNEE","JOINTOWNER","COVERAGEINSURED","ASSIGNEE","ANNUITANT","EXCHANGECOMPANY","JOINTANNUITANT","GRANTOR","TRUSTEE","POWEROFATTORNEY","AUTHORIZEDSIGNATORY","OTHERINTERESTEDPARTY","CONTINGENTOWNER","THIRDPARTYADMINISTRATOR","CARRIER","SUCCESSORTRUSTEE","COVERAGEJOINTINSURED"],"description":"Roles that are essential in structuring life insurance and annuity contracts to meet the financial goals of policyholders and beneficiaries."},"partyStatus":{"type":"string","enum":["APPROVED","NOTAPPROVED","PROCESSED"]},"customerId":{"type":"string","example":"0017b000010N4bCAAS","description":"Assigned by Sales Force and used by all platforms(for Everly). Especially for United web."},"relationshipToParty":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","LIFEPARTNER","MOTHER","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","GRANDPARENT","PARENT","OWNER","SIBLING","STEPCHILD","STEPARENT","OTHER","AUNT","GRANDFATHER","GRANDMOTHER","HUSBAND","WIFE","UNCLE","NIECE","NEPHEW","ESTATE","TRUST","GRANDSON","GRANDDAUGHTER","NONSPOUSE","CHILDRENEQUALLY","CHILDRENPERSTIRPES","PERSTIRPES","SURVIVINGSPOUS","COMORTGAGER","DEPENDENT"],"description":"The type of relationship to the party"},"party":{"$ref":"#/components/schemas/PartyPatchRequestParty"}}},"PartyPatchRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"5df63b47-54fc-4905-a8ff-e1c5f12e667d","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date the Party was added to the Policy"},"partyUpdates":{"type":"array","items":{"$ref":"#/components/schemas/PartyPatchRequestPartyUpdate"}}}},"TransactionResponse":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track each transaction request across all systems"},"transactionId":{"type":"string","description":"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":"337"},"entityId":{"type":"string","example":"1"}}},"Details":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}},"TransactionErrorResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2023-01-01T12:00:00.000Z"},"message":{"type":"string"},"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track each transaction request across all systems"},"errorDetails":{"type":"array","items":{"$ref":"#/components/schemas/Details"}}}},"Attributes":{"type":"object","properties":{"carrierCode":{"type":"string","example":"carrierCode","description":"Carrier Code"},"productCode":{"type":"string","example":"productCode","description":"Product Code"},"productType":{"type":"string","description":"The Product Type refers to the specific category of life insurance or annuity based on its structure, premium flexibility, cash value potential, and investment options. It determines how the policy functions, how premiums are paid, and whether the policy includes a cash accumulation component","example":"productType"},"planName":{"type":"string","description":"The Product Name refers to the specific life insurance or annuity product selected by the contract owner at the time of policy issuance. It identifies the type of coverage, policy structure, and key features associated with the contract","example":"planName"},"renewableIndicator":{"type":"string","example":"renewableIndicator","description":"Renewable Indicator"},"qualifiedPlanType":{"type":"string","example":"qualifiedPlanType","description":"Qualified Plan Type"},"payToYear":{"type":"string","example":"payToYear","description":"Pay To Year"},"policyYear":{"type":"string","description":"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":"policyYear"},"monthOfYear":{"type":"string","description":"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":"monthOfYear"},"policyNumber":{"type":"string","description":"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":"policyNumber"},"policyStatus":{"type":"string","description":"The Policy Status refers to the current standing of a life insurance or annuity contract, indicating whether it is active, inactive, lapsed, or terminated. The status determines whether the policyholder has coverage and whether policy benefits remain in effect","example":"policyStatus"},"issueType":{"type":"string","description":"The Issue Type refers to the classification of how a life insurance or annuity contract is issued, based on underwriting approval, policy structure, or specific issuance conditions. It determines whether the policy was fully underwritten, simplified, guaranteed issue, or part of a group plan","example":"issueType"},"residenceState":{"type":"string","example":"residenceState","description":"Residence State"},"jurisdiction":{"type":"string","example":"jurisdiction","description":"Jurisdiction"},"effectiveDate":{"type":"string","example":"effectiveDate","description":"Effective Date"},"applicationSignedDate":{"type":"string","example":"applicationSignedDate","description":"Application Signed Date"},"issueDate":{"type":"string","example":"issueDate","description":"The Policy Issue Date, also known as the Policy Launch Date, is the date when the insurance company officially issues the policy to the client. This occurs after the application is approved, the insured accepts the offer, and payment information is provided. It marks the formal activation of the policy and triggers policy delivery"},"contestabilityStartDate":{"type":"string","example":"contestabilityStartDate","description":"The Contestability Start Date refers to the beginning of the contestability period, which is the time frame in which an insurance company can investigate and deny a claim if material misrepresentations or fraud are found in the application"},"contestabilityEndDate":{"type":"string","example":"contestabilityEndDate","description":"The Contestability End Date is the date when the contestability period expires, meaning the insurer can no longer deny a claim based on misrepresentation or omission in the application, unless fraud is proven"},"policyDeliveryReceiptDate":{"type":"string","example":"policyDeliveryReceiptDate","description":"Policy Delivery Receipt Date"},"initialPaymentExpirationDate":{"type":"string","example":"initialPaymentExpirationDate","description":"The Initial Payment Amount Expiration Date refers to the deadline by which the initial premium payment must be made to keep the policy offer valid and ensure the policy goes into effect., if not received Policy will be Canceled due to no Premium Set at Issuance"},"nextAnniversaryDate":{"type":"string","example":"nextAnniversaryDate","description":"The Next Policy Anniversary Date refers to the upcoming annual recurrence of the policy’s start date. It is based on the Policy Start Date and marks key policy milestones such as premium due dates, cash value updates, policy renewals, and benefit adjustments"},"nextMonthiversaryDate":{"type":"string","example":"nextMonthiversaryDate","description":"The Next Policy Monthiversary Date refers to the same day of each month that corresponds to the Policy Start Date, marking the monthly recurrence of the policy. It is used for monthly premium payments, cost deductions, cash value calculations, and interest crediting"},"previousAnniversaryDate":{"type":"string","example":"previousAnniversaryDate","description":"Previous Anniversary Date"},"previousMonthiversaryDate":{"type":"string","example":"previousMonthiversaryDate","description":"Previous Monthiversary Date"},"expiryDate":{"type":"string","example":"expiryDate","description":"Expiry Date"},"terminationDate":{"type":"string","example":"terminationDate","description":"Termination Date"},"costBasisDate":{"type":"string","example":"costBasisDate","description":"The Cost Basis Date refers to the date on which the cost basis value of a life insurance policy or annuity contract is calculated. The cost basis represents the total amount of after-tax money contributed to the policy or annuity and is used to determine the taxable portion of withdrawals, loans, or payouts"},"costBasis":{"type":"string","example":"costBasis","description":"The Cost Basis refers to the total cumulative amount of after-tax premiums paid into a life insurance policy or annuity contract. It represents the non-taxable portion of withdrawals, policy loans, or surrenders, ensuring that policyholders are only taxed on gains above this amount"},"currency":{"type":"string","example":"currency","description":"The Currency refers to the system of money in which a life insurance or annuity contract is denominated and transacted. It defines the monetary unit used for premium payments, policy benefits, withdrawals, and payouts"},"claimApprovalDate":{"type":"string","example":"claimApprovalDate","description":"The Claim Approval Date is the date when an insurance company officially approves a claim for payment after verifying the claim details, policy coverage, and required documentation"},"certifiedReceivedDate":{"type":"string","example":"certifiedReceivedDate","description":"The Certified Received Date refers to the date when the insurance company officially receives the certified death paperwork (such as a death certificate) required to process a life insurance claim. This date marks the beginning of the formal claims verification process"},"lossReportDate":{"type":"string","example":"lossReportDate","description":"Loss Report Date"}},"required":["carrierCode","productCode","productType","planName","renewableIndicator","qualifiedPlanType","payToYear","policyYear","monthOfYear","policyNumber","policyStatus","issueType","residenceState","jurisdiction","effectiveDate","applicationSignedDate","issueDate","contestabilityStartDate","contestabilityEndDate","policyDeliveryReceiptDate","initialPaymentExpirationDate","nextAnniversaryDate","nextMonthiversaryDate","previousAnniversaryDate","previousMonthiversaryDate","expiryDate","terminationDate","costBasisDate","costBasis","currency","claimApprovalDate","certifiedReceivedDate","lossReportDate"]},"AccountValueAttributes":{"type":"object","properties":{"cashValueAmount":{"type":"string","example":"1000","description":"Cash Value Amount"},"beginningAccountValue":{"type":"string","example":"2000","description":"The Account Value refers to the total cash value of a life insurance policy or annuity at the beginning of each transaction, including both loaned and unloaned amounts. It represents the policy’s accumulated value before deductions, withdrawals, or new transactions"},"endingAccountValue":{"type":"string","example":"1500","description":"The Current Account Value refers to the total cash value of a life insurance policy or annuity (including loaned and unloaned amounts) as of the last processed transaction. This value is used to determine the available account value (AV) for policyholders and is also the amount on which Fixed Interest is credited"},"minimumAccountValue":{"type":"string","example":"500","description":"Minimum Account Value"},"cashValueByYear":{"type":"string","example":"200","description":"Cash Value By Year"},"unLoanedAcctValue":{"type":"string","example":"300","description":"Unloaned Account Value"},"loanedAcctValue":{"type":"string","example":"100","description":"Loaned Account Value"},"cashSurrenderValue":{"type":"string","example":"800","description":"Cash Surrender Value"},"netAmountAtRisk":{"type":"string","example":"50","description":"The Net Amount at Risk (NAR) is the difference between the policy’s total death benefit and the policy’s account value (cash value). It represents the portion of the death benefit that the insurance company is at risk of paying out beyond the policyholder’s accumulated account value"},"deemedCashValueAmount":{"type":"string","example":"400","description":"Deemed Cash Value Amount"}},"required":["cashValueAmount","beginningAccountValue","endingAccountValue","minimumAccountValue","cashValueByYear","unLoanedAcctValue","loanedAcctValue","cashSurrenderValue","netAmountAtRisk","deemedCashValueAmount"]},"PolicyMetricsAttributes":{"type":"object","properties":{"initialPaymentAmount":{"type":"string","example":"5000","description":"Initial Payment Amount"},"initialPremiumAppliedAmount":{"type":"string","example":"4800","description":"The Initial Premium Applied Amount refers to the portion of the initial premium payment that is officially applied to the policy after processing. This amount determines when the policy becomes active and how funds are allocated within the contract"},"initialPaymentAmountReceivedDate":{"type":"string","example":"2021-01-01","description":"The Initial Premium Amount Received Date refers to the date when the insurance company`s home office officially receives the first premium payment for a life insurance policy or annuity contract. This date is crucial as it determines when the policy processing begins and may impact policy activation timelines"},"grossPremiumAmountSinceIssue":{"type":"string","example":"7500","description":"Gross Premium Amount Since Issue"},"totalCumulativePremiumAmount":{"type":"string","example":"20000","description":"Total Cumulative Premium Amount"},"modifiedEndowmentContractAuthorizationIndicator":{"type":"string","example":"YES","enum":["YES","NO"],"description":"MEC Authorization refers to the approval process required when a life insurance policy is classified as a Modified Endowment Contract (MEC). A MEC is a permanent life insurance policy that fails the IRS \"7-Pay Test,\" resulting in different tax treatment of policy loans and withdrawals. MEC Authorization is typically required from the policyholder before processing transactions that could convert the policy into a MEC, ensuring they understand the tax consequences"},"projectedLapseIndicator":{"type":"string","example":"YES","enum":["YES","NO"],"description":"The Projected Lapse Indicator is a forecast that indicates whether a life insurance policy is expected to lapse within the next policy year based on its current account value, premium payments, cost of insurance (COI), and other policy charges"},"policyGainAmount":{"type":"string","example":"3000","description":"The Policy Gain Amount is the difference between the policy’s total account value and the cost basis. It represents the amount of gain that may be subject to taxation if withdrawn or surrendered"}},"required":["initialPaymentAmount","initialPremiumAppliedAmount","initialPaymentAmountReceivedDate","grossPremiumAmountSinceIssue","totalCumulativePremiumAmount","policyGainAmount"]},"PolicyMetrics":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PolicyMetricsAttributes"}},"required":["attributes"]},"WithdrawalAttributes":{"type":"object","properties":{"totalWithdrawalAmountSinceIssue":{"type":"string","example":"5000","description":"The Total Withdrawal Amount refers to the cumulative amount of funds withdrawn from a life insurance policy or annuity by the policyholder. This includes all withdrawals made since the policy’s inception, whether taken as partial surrenders, cash value withdrawals, or systematic distributions"},"freeWithdrawalAmount":{"type":"string","example":"1000","description":"The Free Withdrawal Amount refers to the maximum amount a policyholder can withdraw from their life insurance policy or annuity in a contract year without incurring a surrender charge. This limit is set by the insurer and is typically expressed as a percentage of the account value or premiums paid"},"minimumWithdrawalAmount":{"type":"string","example":"200","description":"The Minimum Withdrawal Amount refers to the smallest amount a policyholder can withdraw from their life insurance policy or annuity in a single transaction, as defined by the insurer. This ensures that withdrawals remain administratively efficient and align with policy rules"},"maximumWithdrawalAmount":{"type":"string","example":"100","description":"The Maximum Withdrawal Amount refers to the highest amount a policyholder can withdraw from their life insurance policy or annuity in a single transaction or within a policy year, as set by the insurer. This ensures that withdrawals do not deplete the policy’s cash value too quickly or violate contract terms"},"maximumWithdrawalAmountSinceAnniversary":{"type":"string","example":"10"},"numberWithdrawalDuringVestingPeriod":{"type":"string","example":"10"},"numberWithdrawalAfterVestingPeriod":{"type":"string","example":"10"},"cumulativeWithdrawalAmountSinceAnniversary":{"type":"string","example":"10"},"numberWithdrawalSinceIssue":{"type":"string","example":"10"},"withdrawalAllowedStartDate":{"type":"string","description":"The Withdrawal Allowed Start Date refers to the calculated date from which the policyholder is permitted to make withdrawals from the policy’s cash value or annuity funds. This date is determined based on policy terms, surrender charge periods, and regulatory restrictions","example":"10"}},"required":["totalWithdrawalAmountSinceIssue","freeWithdrawalAmount","minimumWithdrawalAmount","maximumWithdrawalAmount","maximumWithdrawalAmountSinceAnniversary","numberWithdrawalDuringVestingPeriod","numberWithdrawalAfterVestingPeriod","cumulativeWithdrawalAmountSinceAnniversary","numberWithdrawalSinceIssue","withdrawalAllowedStartDate"]},"Withdrawal":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/WithdrawalAttributes"}},"required":["attributes"]},"AccountValue":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/AccountValueAttributes"},"policyMetrics":{"$ref":"#/components/schemas/PolicyMetrics"},"loan":{"$ref":"#/components/schemas/Loan"},"withdrawal":{"$ref":"#/components/schemas/Withdrawal"}},"required":["attributes","policyMetrics","loan","withdrawal"]},"TestValueAttributes":{"type":"object","properties":{"guidelineLevelPremiumTestDate":{"type":"string","example":"2021-01-01","description":"Guideline Level Premium Test Date"},"definitionOfLifeInsuranceMethod":{"type":"string","example":"Method A","description":"The Definition of Life Insurance (DLI) refers to the IRS-defined criteria that a life insurance policy must meet to maintain its tax-advantaged status. Policyholders must choose between two IRS-approved tests to ensure compliance: Guideline Premium Test (GPT) Cash Value Accumulation Test (CVAT) Each test has different implications on premium limits, cash value growth, and tax treatment"},"guidelineSinglePremium":{"type":"string","example":"500","description":"The Guideline Single Premium (GSP) refers to the maximum single premium payment that can be made into a life insurance policy without violating the IRS`s Guideline Premium Test (GPT). It is used to ensure that the policy qualifies as life insurance and maintains its tax-advantaged status"},"guidelineAnnualPremium":{"type":"string","example":"1000","description":"Guideline Annual Premium"},"guidelineLevelPremiumExcessPayAmount":{"type":"string","example":"200","description":"Guideline Level Premium Excess Pay Amount"},"cumulativeGuidelineAnnualPremium":{"type":"string","example":"2500","description":"Cumulative Guideline Annual Premium"},"modifiedEndowmentContractTestDate":{"type":"string","example":"2022-01-01","description":"The MEC Test Date refers to the last date on which the life insurance policy was tested to determine whether it qualifies as a Modified Endowment Contract (MEC) under IRS regulations. This date is updated whenever a new MEC test is performed, ensuring the policy remains compliant with federal tax rules"},"modifiedEndowmentContractMaximumContribution":{"type":"string","example":"3000","description":"Modified Endowment Contract Maximum Contribution"},"modifiedEndowmentContractDate":{"type":"string","example":"2022-05-01","description":"Modified Endowment Contract Date"},"modifiedEndowmentContractIndicator":{"type":"string","example":"YES","enum":["YES","NO"],"description":"Modified Endowment Contract Indicator"},"sevenPayPremium":{"type":"string","example":"1500","description":"The 7-Pay Premium refers to the maximum allowable premium that can be paid into a life insurance policy during the first seven years without triggering Modified Endowment Contract (MEC) status. It ensures that the policy remains a tax-advantaged life insurance contract rather than an investment vehicle"},"sevenPayPremiumStartDate":{"type":"string","example":"2023-01-01","description":"Seven Pay Premium Start Date"},"sevenPayYear":{"type":"string","example":"5","description":"Seven Pay Year"},"sevenPayTestBasis":{"type":"string","example":"Basis A","description":"The 7-Pay Test Basis refers to the total cumulative premium paid into a life insurance policy during the first seven years (the 7-pay period), as measured against the IRS 7-Pay Test limit. This amount is used to determine whether the policy qualifies as a life insurance contract or is classified as a Modified Endowment Contract (MEC)."},"sevenPayTestLimit":{"type":"string","example":"3000","description":"Seven Pay Test Limit"},"sevenPayTestYearInPeriod":{"type":"string","example":"2","description":"The Year in Period refers to the current year within the seven-year time frame of the 7-Pay Test. It is crucial because the 7-Pay Limit increases each year, and the test is updated annually to ensure the policy remains within IRS limits"}},"required":["guidelineLevelPremiumTestDate","definitionOfLifeInsuranceMethod","guidelineSinglePremium","guidelineAnnualPremium","guidelineLevelPremiumExcessPayAmount","cumulativeGuidelineAnnualPremium","modifiedEndowmentContractTestDate","modifiedEndowmentContractMaximumContribution","modifiedEndowmentContractDate","sevenPayPremium","sevenPayPremiumStartDate","sevenPayYear","sevenPayTestBasis","sevenPayTestLimit","sevenPayTestYearInPeriod"]},"TestValue":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/TestValueAttributes"}},"required":["attributes"]},"CoverageValueAttributes":{"type":"object","properties":{"totalRiskAmount":{"type":"string","example":"500000","description":"Total Risk Amount"},"minimumBenefitAmount":{"type":"string","example":"10000","description":"Minimum Benefit Amount"},"maximumBenefitAmount":{"type":"string","example":"20000","description":"Maximum Benefit Amount"},"exerciseDate":{"type":"string","example":"2023-06-01","description":"Exercise Date"},"band":{"type":"string","example":"Band A","description":"Band"},"grossDeathBenefitAmount":{"type":"string","example":"45000","description":"Gross Death Benefit Amount"},"lowDeathBenefit":{"type":"string","example":"40000","description":"Low Death Benefit"},"maximumNumberFaceChangesPerYear":{"type":"string","example":"4","description":"Maximum Number of Face Changes Per Year"},"minimumAmountDecrease":{"type":"string","example":"500","description":"Minimum Amount Decrease"},"maximumAmountDecrease":{"type":"string","example":"2000","description":"Maximum Amount Decrease"},"maximumAgeDecreaseAmount":{"type":"string","example":"70","description":"Maximum Age Decrease Amount"},"maximumNumberCoverageDecreasesPerYear":{"type":"string","example":"2","description":"Maximum Number of Coverage Decreases Per Year"},"minimumAmountIncrease":{"type":"string","example":"1000","description":"Minimum Amount Increase"},"maximumAmountIncrease":{"type":"string","example":"3000","description":"Maximum Amount Increase"},"maximumAgeIncreaseAmount":{"type":"string","example":"80","description":"Maximum Age Increase Amount"},"maximumNumberCoverageIncreasesPerYear":{"type":"string","example":"3","description":"Maximum Number of Coverage Increases Per Year"},"netDeathBenefitAmount":{"type":"string","example":"42000","description":"Net Death Benefit Amount"},"deathBenefitRemaining":{"type":"string","example":"20000","description":"Death Benefit Remaining"}},"required":["totalRiskAmount","minimumBenefitAmount","maximumBenefitAmount","exerciseDate","band","grossDeathBenefitAmount","lowDeathBenefit","maximumNumberFaceChangesPerYear","minimumAmountDecrease","maximumAmountDecrease","maximumAgeDecreaseAmount","maximumNumberCoverageDecreasesPerYear","minimumAmountIncrease","maximumAmountIncrease","maximumAgeIncreaseAmount","maximumNumberCoverageIncreasesPerYear","netDeathBenefitAmount","deathBenefitRemaining"]},"CoverageValue":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/CoverageValueAttributes"}},"required":["attributes"]},"CoveragesAttributes":{"type":"object","properties":{"coverageId":{"type":"string","example":"COV123","description":"Coverage ID"},"indicatorCode":{"type":"string","example":"IND123","description":"Indicator Code"},"productCode":{"type":"string","example":"PROD456","description":"Product Code"},"planName":{"type":"string","example":"Platinum Plan","description":"The Product Name refers to the specific life insurance or annuity product selected by the contract owner at the time of policy issuance. It identifies the type of coverage, policy structure, and key features associated with the contract"},"selectionIndicator":{"type":"string","example":"Y","enum":["Y","N"],"description":"Selection Indicator"},"currentAmount":{"type":"string","example":"20000","description":"Current Amount"},"priorCoverageAmount":{"type":"string","example":"18000","description":"Prior Coverage Amount"},"minimumBenefitAmount":{"type":"string","example":"15000","description":"Minimum Benefit Amount"},"maximumBenefitAmount":{"type":"string","example":"25000","description":"Maximum Benefit Amount"},"grossDeathBenefitAmount":{"type":"string","example":"5000","description":"Gross Death Benefit Amount"},"lowDeathBenefit":{"type":"string","example":"2000","description":"Low Death Benefit"},"coverageChangeAmount":{"type":"string","example":"3000","description":"Coverage Change Amount"},"effectiveDate":{"type":"string","example":"2022-01-01","description":"Effective Date"},"coverageChangeEffectiveDate":{"type":"string","example":"2021-12-01","description":"Coverage Change Effective Date"},"terminationDate":{"type":"string","example":"2022-12-31","description":"Termination Date"},"currentNumberOfUnits":{"type":"string","example":"100","description":"Current Number of Units"},"valuePerUnit":{"type":"string","example":"50","description":"Value Per Unit"},"premiumModalFactor":{"type":"string","example":"1.5","description":"Premium Modal Factor"},"exerciseDate":{"type":"string","example":"2023-03-15","description":"Exercise Date"},"lifeCoverageStatus":{"type":"string","example":"Active","description":"Life Coverage Status"},"claimStatus":{"type":"string","example":"Pending","description":"The Claim Status refers to the current stage of a life insurance claim, indicating whether the claim has been processed, approved, denied, or is still under review. This status helps policyholders, beneficiaries, and insurers track the progress of a claim from submission to payout"},"nextEvaluationDate":{"type":"string","example":"2023-12-01","description":"Next Evaluation Date"},"paymentMode":{"type":"string","example":"Monthly","description":"Payment Mode"},"maximumBenefitPercent":{"type":"string","example":"80%","description":"Maximum Benefit Percent"},"maximumPayPeriod":{"type":"string","example":"365","description":"Maximum Pay Period"},"guidelineSinglePremium":{"type":"string","example":"5000","description":"The Guideline Single Premium (GSP) refers to the maximum single premium payment that can be made into a life insurance policy without violating the IRS`s Guideline Premium Test (GPT). It is used to ensure that the policy qualifies as life insurance and maintains its tax-advantaged status"},"guidelineAnnualPremium":{"type":"string","example":"2000","description":"Guideline Annual Premium"},"sevenPayPremium":{"type":"string","example":"700","description":"The 7-Pay Premium refers to the maximum allowable premium that can be paid into a life insurance policy during the first seven years without triggering Modified Endowment Contract (MEC) status. It ensures that the policy remains a tax-advantaged life insurance contract rather than an investment vehicle"},"coverageReferenceId":{"type":"string","example":"REF456","description":"Coverage Reference ID"},"tier1MaximumBenefitAmount":{"type":"string","example":"10000","description":"Tier 1 Maximum Benefit Amount"},"tier1MaximumBenefitPercent":{"type":"string","example":"60%","description":"Tier 1 Maximum Benefit Percent"},"tier2MaximumBenefitAmount":{"type":"string","example":"15000","description":"Tier 2 Maximum Benefit Amount"},"tier2MaximumBenefitPercent":{"type":"string","example":"70%","description":"Tier 2 Maximum Benefit Percent"}},"required":["coverageId","indicatorCode","productCode","planName","currentAmount","priorCoverageAmount","minimumBenefitAmount","maximumBenefitAmount","grossDeathBenefitAmount","lowDeathBenefit","coverageChangeAmount","effectiveDate","coverageChangeEffectiveDate","terminationDate","currentNumberOfUnits","valuePerUnit","premiumModalFactor","exerciseDate","lifeCoverageStatus","claimStatus","nextEvaluationDate","paymentMode","maximumBenefitPercent","maximumPayPeriod","guidelineSinglePremium","guidelineAnnualPremium","sevenPayPremium","coverageReferenceId","tier1MaximumBenefitAmount","tier1MaximumBenefitPercent","tier2MaximumBenefitAmount","tier2MaximumBenefitPercent"]},"ParticipantAttributes":{"type":"object","properties":{"partyId":{"type":"string","example":"PARTY123","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions"},"issueAge":{"type":"string","example":"30","description":"Issue Age"},"underwritingClass":{"type":"string","example":"Preferred","enum":["Preferred","Standard"],"description":"Underwriting Class"},"temporaryTableRating":{"type":"string","example":"Table A","description":"Temporary Table Rating"}},"required":["partyId","issueAge","temporaryTableRating"]},"Participant":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ParticipantAttributes"},"flatExtra":{"type":"array","items":{"$ref":"#/components/schemas/FlatExtra"}}},"required":["attributes","flatExtra"]},"FeeAttributes":{"type":"object","properties":{"feeType":{"type":"string","example":"Admin Fee","description":"Fee Type"},"feeAmount":{"type":"string","example":"50","description":"Fee Amount"},"startDate":{"type":"string","example":"2022-01-01","description":"Start Date"},"effectiveRate":{"type":"string","example":"5%","enum":["5%","10%","15%"],"description":"Effective Rate"},"feeWaivedIndicator":{"type":"string","example":"Y","enum":["Y","N"],"description":"Fee Waived Indicator"}},"required":["feeType","feeAmount","startDate"]},"Fee":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/FeeAttributes"}},"required":["attributes"]},"Coverages":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/CoveragesAttributes"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}},"fees":{"type":"array","items":{"$ref":"#/components/schemas/Fee"}}},"required":["attributes","participants","fees"]},"PolicyFeeAttributes":{"type":"object","properties":{"feeId":{"type":"string","example":"FEE123","description":"Fee ID"},"feeType":{"type":"string","example":"Admin Fee","description":"Fee Type"},"startDate":{"type":"string","example":"2022-01-01","description":"Start Date"},"effectiveRate":{"type":"string","example":"5%","enum":["5%","10%","15%"],"description":"Effective Rate"},"feeAmount":{"type":"string","example":"50","description":"Fee Amount"},"netAmountAtRisk":{"type":"string","example":"100","description":"The Net Amount at Risk (NAR) is the difference between the policy’s total death benefit and the policy’s account value (cash value). It represents the portion of the death benefit that the insurance company is at risk of paying out beyond the policyholder’s accumulated account value"}},"required":["feeId","feeType","startDate","feeAmount","netAmountAtRisk"]},"PolicyFee":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PolicyFeeAttributes"}},"required":["attributes"]},"FeaturesAttributes":{"type":"object","properties":{"freeLookInvestDuration":{"type":"string","example":"12","description":"Free Look-Invest Duration"},"freeLookExpirationDate":{"type":"string","example":"2022-06-30","description":"Free Look-Invest Expiration Date"}},"required":["freeLookInvestDuration","freeLookExpirationDate"]},"LapseAssessmentAttributes":{"type":"object","properties":{"lapseIndicator":{"type":"string","example":"Y","enum":["Y","N"],"description":"Lapse Indicator"},"gracePeriodStartDate":{"type":"string","example":"2022-03-15","description":"Grace Period Start Date"},"gracePeriodEndDate":{"type":"string","example":"2022-06-15","description":"Grace Period End Date"},"lapseEffectiveDate":{"type":"string","example":"2022-06-15","description":"Lapse Effective Date"},"totalLapsePendingAmount":{"type":"string","example":"150","description":"Total Lapse Pending Amount"},"minimumLapsePendingAmount":{"type":"string","example":"50","description":"Minimum Lapse Pending Amount"}},"required":["gracePeriodStartDate","gracePeriodEndDate","lapseEffectiveDate","totalLapsePendingAmount","minimumLapsePendingAmount"]},"LapseAssessment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/LapseAssessmentAttributes"}},"required":["attributes"]},"LapseProtectionAttributes":{"type":"object","properties":{"startDate":{"type":"string","example":"2022-01-01","description":"Start Date"},"endDate":{"type":"string","example":"2022-12-31","description":"End Date"},"monthlyPayment":{"type":"string","example":"20","description":"Monthly Payment"},"cumulativePayment":{"type":"string","example":"120","description":"Cumulative Payment"},"guaranteedPeriod":{"type":"string","example":"24","description":"Guaranteed Period"}},"required":["startDate","endDate","monthlyPayment","cumulativePayment","guaranteedPeriod"]},"LapseProtection":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/LapseProtectionAttributes"}},"required":["attributes"]},"ReinstatementAttributes":{"type":"object","properties":{"lastReinstatementDate":{"type":"string","example":"2021-12-31","description":"Last Reinstatement Date"},"maxReinstatementYrs":{"type":"string","example":"3","description":"Max Reinstatement Years"},"underwritingDecision":{"type":"string","example":"Approved","description":"Underwriting Decision"},"approvalDate":{"type":"string","example":"2022-01-01","description":"Approval Date"},"effectiveDate":{"type":"string","example":"2022-03-15","description":"Effective Date"},"expirationDate":{"type":"string","example":"2022-12-31","description":"Expiration Date"},"paymentAmount":{"type":"string","example":"30","description":"Payment Amount"}},"required":["lastReinstatementDate","maxReinstatementYrs","underwritingDecision","approvalDate","effectiveDate","expirationDate","paymentAmount"]},"Reinstatement":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ReinstatementAttributes"}},"required":["attributes"]},"Features":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/FeaturesAttributes"},"lapseAssessment":{"$ref":"#/components/schemas/LapseAssessment"},"lapseProtection":{"$ref":"#/components/schemas/LapseProtection"},"reinstatement":{"$ref":"#/components/schemas/Reinstatement"}},"required":["attributes","lapseAssessment","lapseProtection","reinstatement"]},"FundAllocationsAttributes":{"type":"object","properties":{"productFullName":{"type":"string","example":"Product A","description":"Product Full Name"},"fundId":{"type":"string","example":"FUND123","description":"Fund ID"},"allocationPercent":{"type":"string","example":"20%","description":"Allocation Percent"},"startDate":{"type":"string","example":"2022-01-01","description":"Start Date"},"endDate":{"type":"string","example":"2022-12-31","description":"End Date"}},"required":["productFullName","fundId","allocationPercent","startDate","endDate"]},"FundAllocations":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/FundAllocationsAttributes"}},"required":["attributes"]},"FundAttributes":{"type":"object","properties":{"fundId":{"type":"string","example":"FUND456","description":"Fund ID"},"accountType":{"type":"string","example":"Savings Account","description":"Account Type"},"fundFullName":{"type":"string","example":"Fund XYZ","description":"Fund Full Name"},"ledgerCode":{"type":"string","example":"ABC123","description":"Ledger Code"},"totalValue":{"type":"string","example":"5000","description":"Total Value"}},"required":["fundId","accountType","fundFullName","ledgerCode","totalValue"]},"SegmentAttributes":{"type":"object","properties":{"segmentId":{"type":"string","example":"SEG123","description":"Segment ID"},"originalDepositAmount":{"type":"string","example":"1000","description":"Original Deposit Amount"},"originalDepositDate":{"type":"string","example":"2022-01-01","description":"Original Deposit Date"},"depositDate":{"type":"string","example":"2022-01-15","description":"Deposit Date"},"depositAmount":{"type":"string","example":"500","description":"Deposit Amount"},"currentAmount":{"type":"string","example":"600","description":"Current Amount"},"numberOfUnits":{"type":"string","example":"10","description":"Number of Units"},"renewalDate":{"type":"string","example":"2023-01-01","description":"Renewal Date"},"sweepAccountId":{"type":"string","example":"SWEEP001","description":"Sweep Account ID"},"startDate":{"type":"string","example":"2022-01-01","description":"Start Date"},"endDate":{"type":"string","example":"2022-12-31","description":"End Date"}},"required":["segmentId","originalDepositAmount","originalDepositDate","depositDate","depositAmount","currentAmount","numberOfUnits","renewalDate","sweepAccountId","startDate","endDate"]},"Segment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/SegmentAttributes"}},"required":["attributes"]},"Funds":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/FundAttributes"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}},"required":["attributes","segments"]},"ArrangementsAttributes":{"type":"object","properties":{"arrangementId":{"type":"string"},"arrangementType":{"type":"string"},"arrangementMode":{"type":"string"},"paymentForm":{"type":"string"},"numberOfModalOccurences":{"type":"string"},"requestedAmount":{"type":"string"},"appliedAmount":{"type":"string"},"calculatedAmount":{"type":"string"},"taxableGainAmount":{"type":"string"},"loanType":{"type":"string"},"loanInterestType":{"type":"string"},"loanPaymentType":{"type":"string"},"disbursementType":{"type":"string"},"sourceTransferAmountType":{"type":"string"},"requestedPercent":{"type":"string"},"requestedDate":{"type":"string"},"effectiveDate":{"type":"string"},"totalChargeAmount":{"type":"string"},"arrStatus":{"type":"string"},"startDate":{"type":"string"},"reason":{"type":"string"},"nextActivityDate":{"type":"string"},"lastActivityDate":{"type":"string"},"endDate":{"type":"string"},"valueAdjustmentFundId":{"type":"string"},"valueAdjustmentCoverageId":{"type":"string"},"valueAdjustmentPriorAmount":{"type":"string"},"valueAdjustmentSegmentId":{"type":"string"}},"required":["arrangementId","arrangementType","arrangementMode","paymentForm","numberOfModalOccurences","requestedAmount","appliedAmount","calculatedAmount","taxableGainAmount","loanType","loanInterestType","loanPaymentType","disbursementType","sourceTransferAmountType","requestedPercent","requestedDate","effectiveDate","totalChargeAmount","arrStatus","startDate","reason","nextActivityDate","lastActivityDate","endDate","valueAdjustmentFundId","valueAdjustmentCoverageId","valueAdjustmentPriorAmount","valueAdjustmentSegmentId"]},"TaxWithHoldingAttributes":{"type":"object","properties":{"taxWithholdingPlace":{"type":"string"},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions"},"taxWithheldAmount":{"type":"string"},"taxWithheldPercent":{"type":"string"},"taxWithholdingType":{"type":"string"},"withholdingNumberExemptions":{"type":"string"},"maritalStatus":{"type":"string"},"taxJurisdiction":{"type":"string"},"taxableAmount":{"type":"string"}},"required":["taxWithholdingPlace","partyId","taxWithheldAmount","taxWithheldPercent","taxWithholdingType","withholdingNumberExemptions","maritalStatus","taxJurisdiction","taxableAmount"]},"TaxWithHolding":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/TaxWithHoldingAttributes"}},"required":["attributes"]},"PaymentAttributes":{"type":"object","properties":{"partyRole":{"type":"string"},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions"},"bankId":{"type":"string"},"allocationPercent":{"type":"string"},"paymentAmount":{"type":"string"}},"required":["partyRole","partyId","bankId","allocationPercent","paymentAmount"]},"Payment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PaymentAttributes"}},"required":["attributes"]},"ArrangementsFeeAttributes":{"type":"object","properties":{"feeType":{"type":"string"},"feeAmount":{"type":"string"},"startDate":{"type":"string"},"effectiveRate":{"type":"string"},"feeWaivedIndicator":{"type":"string"}},"required":["feeType","feeAmount","startDate","effectiveRate","feeWaivedIndicator"]},"ArrangementsFee":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementsFeeAttributes"}},"required":["attributes"]},"ArrangementSourcesAttributes":{"type":"object","properties":{"fundId":{"type":"string"},"transferAmount":{"type":"string"},"transferPercent":{"type":"string"}},"required":["fundId","transferAmount","transferPercent"]},"ArrangementSegmentAttributes":{"type":"object","properties":{"segmentId":{"type":"string"},"requestedAmount":{"type":"string"}},"required":["segmentId","requestedAmount"]},"ArrangementFinancialActivityAttributes":{"type":"object","properties":{"interestPostingRate":{"type":"string"},"amount":{"type":"string"}},"required":["interestPostingRate","amount"]},"ArrangementFinancialActivity":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementFinancialActivityAttributes"}},"required":["attributes"]},"ArrangementSegment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementSegmentAttributes"},"financialActivity":{"$ref":"#/components/schemas/ArrangementFinancialActivity"}},"required":["attributes","financialActivity"]},"ArrangementSource":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementSourcesAttributes"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/ArrangementSegment"}}},"required":["attributes","segments"]},"ArrangementLoanSegmentAttributes":{"type":"object","properties":{"segmentId":{"type":"string"},"requestedAmount":{"type":"string"}},"required":["segmentId","requestedAmount"]},"ArrangementLoanSegmentFinancialActivityAttributes":{"type":"object","properties":{"interestPostingRate":{"type":"string"},"amount":{"type":"string"}},"required":["interestPostingRate","amount"]},"ArrangementLoanSegmentFinancialActivity":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementLoanSegmentFinancialActivityAttributes"}},"required":["attributes"]},"ArrangementLoanSegment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementLoanSegmentAttributes"},"financialActivity":{"$ref":"#/components/schemas/ArrangementLoanSegmentFinancialActivity"}},"required":["attributes","financialActivity"]},"ArrangementsMatchSegmentAttributes":{"type":"object","properties":{"segmentId":{"type":"string"},"requestedAmount":{"type":"string"}},"required":["segmentId","requestedAmount"]},"MatchSegmentFinancialActivityAttributes":{"type":"object","properties":{"interestPostingRate":{"type":"string"},"amount":{"type":"string"}},"required":["interestPostingRate","amount"]},"MatchSegmentFinancialActivity":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/MatchSegmentFinancialActivityAttributes"}},"required":["attributes"]},"ArrangementsMatchSegment":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementsMatchSegmentAttributes"},"financialActivity":{"$ref":"#/components/schemas/MatchSegmentFinancialActivity"}},"required":["attributes","financialActivity"]},"DeathClaimAttributes":{"type":"object","properties":{"statutoryInterestAmount":{"type":"string"},"payoutPreSupplementalSecurityIncome":{"type":"string"},"interestCalculationDate":{"type":"string"},"statutoryInterestRate":{"type":"string"}},"required":["statutoryInterestAmount","payoutPreSupplementalSecurityIncome","interestCalculationDate","statutoryInterestRate"]},"DeathClaim":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day","format":"date"},"reverseInitiator":{"type":"boolean","default":false,"description":"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"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"transactionAmounts":{"$ref":"#/components/schemas/DeathClaimTransactionAmounts"},"transactionReason":{"type":"string","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","FACEINCREASECOVERAGE","MECAUTHORIZATION","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS","DATEOFDEATH","INITIALDEATHNOTIFICATION","PRODUCTDEFAULT","GWBRIDERDISBURSEMENT","GWBPHASECHANGE","PREMIUMLOAN","PAYMENTDUEDATE"],"description":"The justification or business reason for the transaction"},"payeeOrBeneficiary":{"deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/DeathClaimPayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"policy":{"$ref":"#/components/schemas/DeathClaimAdhocPolicy"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"payoutInformation":{"$ref":"#/components/schemas/PayoutInformation"},"taxWithholdingInstructions":{"$ref":"#/components/schemas/TaxWithholdingInstructions"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"Arrangements":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ArrangementsAttributes"},"taxWithHolding":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithHolding"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"fees":{"type":"array","items":{"$ref":"#/components/schemas/ArrangementsFee"}},"arrangementSources":{"type":"array","items":{"$ref":"#/components/schemas/ArrangementSource"}},"loanSegments":{"type":"array","items":{"$ref":"#/components/schemas/ArrangementLoanSegment"}},"matchSegment":{"$ref":"#/components/schemas/ArrangementsMatchSegment"},"deathClaim":{"$ref":"#/components/schemas/DeathClaim"}},"required":["attributes","taxWithHolding","payments","fees","arrangementSources","loanSegments","matchSegment","deathClaim"]},"LPSPayloadResponse":{"type":"object","properties":{"attributes":{"description":"Attributes","allOf":[{"$ref":"#/components/schemas/Attributes"}]},"accountValue":{"description":"Account Value","allOf":[{"$ref":"#/components/schemas/AccountValue"}]},"testValue":{"description":"Test Value","allOf":[{"$ref":"#/components/schemas/TestValue"}]},"deathBenefit":{"description":"Death Benefit","allOf":[{"$ref":"#/components/schemas/DeathBenefit"}]},"coverageValue":{"description":"Coverage Value","allOf":[{"$ref":"#/components/schemas/CoverageValue"}]},"coverages":{"description":"Array of Coverages","type":"array","items":{"$ref":"#/components/schemas/Coverages"}},"parties":{"description":"Array of Parties","type":"array","items":{"$ref":"#/components/schemas/Parties"}},"policyFee":{"description":"Policy Fee","allOf":[{"$ref":"#/components/schemas/PolicyFee"}]},"features":{"description":"Features","allOf":[{"$ref":"#/components/schemas/Features"}]},"fundAllocations":{"description":"Array of Fund Allocations","type":"array","items":{"$ref":"#/components/schemas/FundAllocations"}},"funds":{"description":"Array of Funds","type":"array","items":{"$ref":"#/components/schemas/Funds"}},"matchSegment":{"description":"Match Segment","allOf":[{"$ref":"#/components/schemas/MatchSegment"}]},"loanSegments":{"description":"Array of Loan Segments","type":"array","items":{"$ref":"#/components/schemas/LoanSegment"}},"arrangements":{"description":"Array of Arrangements","type":"array","items":{"$ref":"#/components/schemas/Arrangements"}}},"required":["attributes","accountValue","testValue","deathBenefit","coverageValue","coverages","parties","policyFee","features","fundAllocations","funds","matchSegment","loanSegments","arrangements"]},"PolicyFeatureRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"},"reverseInitiator":{"type":"boolean"},"policyFeatures":{"type":"array","items":{"$ref":"#/components/schemas/PolicyFeature"}}}},"AccountInfo":{"type":"object","properties":{"SourceSystem":{"type":"string","enum":["LC"]},"ContractNumber":{"type":"string"},"ContractId":{"type":"string"},"CovId":{"type":"string"},"QualTypeCode":{"type":"string"},"QualTypeDesc":{"type":"string"},"ApplicationDate":{"format":"date-time","type":"string"},"ModifiedEndowmentStatus":{"type":"string"},"MaturityDate":{"format":"date-time","type":"string"},"ProductLine":{"type":"string"},"ProductCategory":{"type":"string"},"ProductName":{"type":"string"},"PlanCode":{"type":"string"},"IssueState":{"type":"string"},"IssueDate":{"format":"date-time","type":"string"},"EffectiveDate":{"format":"date-time","type":"string"},"ContractStatus":{"type":"string"},"DeathBenefit":{"type":"string"},"MVAProduct":{"type":"string"},"ProductShareClass":{"type":"string"},"ProductCompanyId":{"type":"number"},"FaceAmount":{"type":"number"},"CashValue":{"type":"number"},"LengthofTerm":{"type":"number"},"LastUpdated":{"format":"date-time","type":"string"},"TokenId":{"type":"string"},"JurisdictionStateCode":{"type":"string"},"Owners":{"type":"array","items":{"$ref":"#/components/schemas/Owner"}}},"required":["SourceSystem","ContractNumber","ContractId","CovId","QualTypeCode","QualTypeDesc","ApplicationDate","ModifiedEndowmentStatus","MaturityDate","ProductLine","ProductCategory","ProductName","PlanCode","IssueState","IssueDate","EffectiveDate","ContractStatus","DeathBenefit","MVAProduct","ProductShareClass","ProductCompanyId","FaceAmount","CashValue","LengthofTerm","LastUpdated","TokenId","JurisdictionStateCode","Owners"]},"Banking":{"type":"object","properties":{"BankId":{"type":"number"},"BankName":{"type":"string"},"RoutingNumber":{"type":"string"},"AccountNumber":{"type":"string"},"AccountType":{"type":"string"},"Purpose":{"type":"string"},"PaymentMethod":{"type":"string"},"BankStartDate":{"format":"date-time","type":"string"},"BankEndDate":{"format":"date-time","type":"string"},"ListBillId":{"type":"number"}},"required":["BankId","BankName","RoutingNumber","AccountNumber","AccountType","Purpose","PaymentMethod","BankStartDate","BankEndDate","ListBillId"]},"People":{"type":"object","properties":{"SourceSystem":{"type":"string","enum":["LC"]},"Role":{"type":"string"},"SrcRole":{"type":"string"},"SrcRoleOptionIdDesc":{"type":"string"},"SrcNameId":{"type":"number"},"SrcRoleType":{"type":"number"},"RoleStartDate":{"format":"date-time","type":"string"},"RoleEndDate":{"format":"date-time","type":"string"},"RoleStatus":{"type":"string"},"FullName":{"type":"string"},"OrgName":{"type":"string"},"TaxId":{"type":"string"},"PersonType":{"type":"string"},"SrcPartyType":{"type":"string"},"Email":{"type":"string"},"Address":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Phone":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"Banking":{"type":"array","items":{"$ref":"#/components/schemas/Banking"}},"TaxWithHolding":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithHolding"}},"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"DateOfBirth":{"format":"date-time","type":"string"}},"required":["SourceSystem","Role","SrcRole","SrcRoleOptionIdDesc","SrcNameId","SrcRoleType","RoleStartDate","RoleEndDate","RoleStatus","FullName","OrgName","TaxId","PersonType","SrcPartyType","Email","Address","Phone","Banking","TaxWithHolding","FirstName","MiddleName","LastName","DateOfBirth"]},"ApiRequestHeaderValue":{"type":"object","properties":{"externalId":{"type":"string"},"externalUserId":{"type":"string"},"externalSystemId":{"type":"string"},"externalUserCompHrchyId":{"type":"string"},"muleCorrelationId":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"apiRequestUUID":{"type":"string"},"apiName":{"type":"string"},"externalTransactionName":{"type":"string"},"clientCode":{"type":"string"},"externalUserIdValid":{"type":"string"}},"required":["externalId","externalUserId","externalSystemId","externalUserCompHrchyId","muleCorrelationId","timestamp","apiRequestUUID","apiName","externalTransactionName","clientCode","externalUserIdValid"]},"PolicyCommonRequestValue":{"type":"object","properties":{"contractNumber":{"type":"string"},"companyId":{"type":"number"},"companyHierarchyId":{"type":"number"},"planCode":{"type":"string"},"policyNumber":{"type":"number"},"cvgId":{"type":"number"}},"required":["contractNumber","companyId","companyHierarchyId","planCode","policyNumber","cvgId"]},"StatusValue":{"type":"object","properties":{"statusCode":{"type":"string"},"statusMessage":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["statusCode","statusMessage","errors"]},"AllocationDetailItem":{"type":"object","properties":{"dbAmount":{"type":"number"},"dbFixedPct":{"type":"number"},"dbNonLifePayoutExclAmt":{"type":"number"},"dbPctGMWBPayment":{"type":"number"},"dbPriorMRDAmt":{"type":"number"},"policyNumber":{"type":"number"},"cvgId":{"type":"number"},"typeOfAlloc":{"type":"number"},"startDate":{"format":"date-time","type":"string"},"termDate":{"format":"date-time","type":"string"},"mode":{"type":"string"},"nextDate":{"format":"date-time","type":"string"},"lastTxnDate":{"format":"date-time","type":"string"},"termBy":{"type":"string"},"modePeriods":{"type":"number"},"amountType":{"type":"number"},"distributionCode":{"type":"string"},"allocationId":{"type":"number"},"firstPayYear":{"type":"string"},"firstPayYearDate":{"format":"date-time","type":"string"},"calcType":{"type":"number"},"count":{"type":"number"},"duration":{"type":"number"},"dcaSweep":{"type":"number"},"earningsRefreshDate":{"format":"date-time","type":"string"},"loanId":{"type":"number"},"grossDisbInd":{"type":"number"},"programCounter":{"type":"number"},"moneySrcId":{"type":"number"},"firstNextDate":{"format":"date-time","type":"string"},"waive":{"type":"number"},"waiveMVA":{"type":"number"},"waiveBonusRecap":{"type":"number"},"refundOnly":{"type":"number"},"treatAsNonTaxable":{"type":"boolean"},"waiveLimits":{"type":"number"},"evaluateGMWBAmt":{"type":"number"},"advisorConsultation":{"type":"number"},"featureChange":{"type":"number"},"taxExclType":{"type":"number"},"firstSSWBasis":{"type":"number"},"priorMRDAmtType":{"type":"number"},"batch":{"type":"number"}},"required":["dbAmount","dbFixedPct","dbNonLifePayoutExclAmt","dbPctGMWBPayment","dbPriorMRDAmt","policyNumber","cvgId","typeOfAlloc","startDate","termDate","mode","nextDate","lastTxnDate","termBy","modePeriods","amountType","distributionCode","allocationId","firstPayYear","firstPayYearDate","calcType","count","duration","dcaSweep","earningsRefreshDate","loanId","grossDisbInd","programCounter","moneySrcId","firstNextDate","waive","waiveMVA","waiveBonusRecap","refundOnly","treatAsNonTaxable","waiveLimits","evaluateGMWBAmt","advisorConsultation","featureChange","taxExclType","firstSSWBasis","priorMRDAmtType","batch"]},"SpecialProgramDetails":{"type":"object","properties":{"apiRequestHeader":{"$ref":"#/components/schemas/ApiRequestHeaderValue"},"policyCommonRequest":{"$ref":"#/components/schemas/PolicyCommonRequestValue"},"status":{"$ref":"#/components/schemas/StatusValue"},"allocationDetails":{"type":"array","items":{"$ref":"#/components/schemas/AllocationDetailItem"}}},"required":["apiRequestHeader","policyCommonRequest","status","allocationDetails"]},"CashValuesItem":{"type":"object","properties":{"SourceSystem":{"type":"string","enum":["LC"]},"AsOfDate":{"format":"date-time","type":"string"},"SurrenderCharge":{"type":"number"},"AccountValue":{"type":"number"},"LoanPrinciple":{"type":"number"},"CashValue":{"type":"number"},"CumulativePremiumAmount":{"type":"number"},"MinimumDeathBenefit":{"type":"number"},"GuaranteedMinimumDeathBenefit":{"type":"number"},"DeathBenefitAmount":{"type":"number"},"YtdPremiumAmount":{"type":"number"},"YtdWithdrawal":{"type":"number"},"TotalWithdrawal":{"type":"number"},"GWB":{"type":"number"},"DeathBenefitValue":{"type":"number"},"NetCashSurrenderValue":{"type":"number"},"RequiredMinimumDistribution":{"type":"number"},"GuaranteedCashSurrenderValueIndex":{"type":"number"},"GuaranteedCashSurrenderValue":{"type":"number"},"FreeWithdrawalAmount":{"type":"number"},"FreeWithdrawalRemaining":{"type":"number"},"GuaranteedAnnualPaymen":{"type":"number"}},"required":["SourceSystem","AsOfDate","SurrenderCharge","AccountValue","LoanPrinciple","CashValue","CumulativePremiumAmount","MinimumDeathBenefit","GuaranteedMinimumDeathBenefit","DeathBenefitAmount","YtdPremiumAmount","YtdWithdrawal","TotalWithdrawal","GWB","DeathBenefitValue","NetCashSurrenderValue","RequiredMinimumDistribution","GuaranteedCashSurrenderValueIndex","GuaranteedCashSurrenderValue","FreeWithdrawalAmount","FreeWithdrawalRemaining","GuaranteedAnnualPaymen"]},"CashValues":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CashValuesItem"}}},"required":["Items"]},"NotesInfo":{"type":"object","properties":{"Count":{"type":"number"},"Items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["Count","Items"]},"PolicyNote":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"Unique identifier for the note"},"notePriority":{"type":"string","description":"Priority level of the note","example":"High"},"dateEntered":{"type":"string","description":"Date when the note was initially entered","example":"2024-01-15T10:30:00Z","format":"date-time"},"summary":{"type":"string","description":"Brief summary of the note","example":"Policy review required"},"noteCategory":{"type":"string","description":"Category classification of the note","example":"Administrative"},"noteType":{"type":"string","description":"Type classification of the note","example":"Review"},"notes":{"type":"string","description":"Detailed note content","example":"Annual policy review is due. Please schedule appointment with policy holder."},"role":{"type":"string","description":"Role of the person who created the note","example":"Administrator"},"alertDisableDate":{"type":"string","description":"Date when the note should be disabled","example":"2024-02-15T10:30:00Z","format":"date-time"},"alertIndicator":{"type":"boolean","description":"Whether this note triggers an alert","example":true},"userId":{"type":"string","description":"ID of the user who created the note","example":"admin001"},"timestamp":{"type":"string","description":"Date when the note was last modified","example":"2024-01-15T10:30:00Z","format":"date-time"},"endDate":{"type":"string","description":"Date when the note expires","example":"2024-02-15T10:30:00Z","format":"date-time"}},"required":["id","notePriority","dateEntered","summary","noteCategory","noteType","notes","role","alertDisableDate","alertIndicator","userId","timestamp","endDate"]},"FundValuesItem":{"type":"object","properties":{"SourceSystem":{"type":"string","enum":["LC"]},"FundId":{"type":"string"},"FundName":{"type":"string"},"SrcFundName":{"type":"string"},"FundType":{"type":"string"},"Units":{"type":"string"},"UnitValue":{"type":"string"},"Value":{"type":"string"},"AssetSource":{"type":"string"},"AssetSourceCode":{"type":"string"},"AsOfDate":{"format":"date-time","type":"string"},"InterestRate":{"type":"string"},"IndexBOP":{"type":"string"}},"required":["SourceSystem","FundId","FundName","SrcFundName","FundType","Units","UnitValue","Value","AssetSource","AssetSourceCode","AsOfDate","InterestRate","IndexBOP"]},"FundValues":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/FundValuesItem"}}},"required":["Items"]},"LinkBankingItem":{"type":"object","properties":{"SourceSystem":{"type":"string","enum":["LC"]},"BankId":{"type":"string"},"BankName":{"type":"string"},"ABANumber":{"type":"string"},"AccountNumber":{"type":"string"},"BankStartDate":{"format":"date-time","type":"string"},"BankEndDate":{"format":"date-time","type":"string"},"BankingTypeDesc":{"type":"string"}},"required":["SourceSystem","BankId","BankName","ABANumber","AccountNumber","BankStartDate","BankEndDate","BankingTypeDesc"]},"LinkBanking":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LinkBankingItem"}}},"required":["Items"]},"Quote":{"type":"object","properties":{"ClientCode":{"type":"string"},"ContractNumber":{"type":"string"},"PlanCode":{"type":"string"},"UserId":{"type":"string"},"TransactionDate":{"type":"string"},"TransactionTime":{"type":"string"},"Withdrawal":{"type":"array","items":{"$ref":"#/components/schemas/Withdrawal"}}},"required":["ClientCode","ContractNumber","PlanCode","UserId","TransactionDate","TransactionTime","Withdrawal"]},"PhoneChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"isPreferredPhone":{"type":"string","description":"This field is deprecated and will be removed in a future version. Please use phone.isPreferred instead.","enum":["YES","NO"]},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")","format":"date"},"phone":{"$ref":"#/components/schemas/PhoneBase"}}},"EmailChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"isPreferredEmail":{"type":"string","description":"This field is deprecated and will be removed in a future version. Please use email.isPreferred instead.","enum":["YES","NO"],"deprecated":true},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file.","example":"1"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")","format":"date"},"email":{"$ref":"#/components/schemas/EmailBase"}}},"AddressChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"preferredAddressIndicator":{"type":"string","enum":["YES","NO"],"description":"This field is deprecated and will be removed in a future version. Please use address.isPreferred instead."},"isPreferredAddress":{"type":"string","enum":["YES","NO"],"description":"This field is deprecated and will be removed in a future version. Please use address.isPreferred instead."},"preferredAddressId":{"type":"string","example":"1","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping."},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"address":{"$ref":"#/components/schemas/AddressBase"},"isAddressSameAsOwner":{"type":"boolean","description":"Boolean 0 = No 1 = Yes to denote if the email is the preferred"},"transactionReason":{"type":"string","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","FACEINCREASECOVERAGE","MECAUTHORIZATION","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS","DATEOFDEATH","INITIALDEATHNOTIFICATION","PRODUCTDEFAULT","GWBRIDERDISBURSEMENT","GWBPHASECHANGE","PREMIUMLOAN","PAYMENTDUEDATE"],"description":"The justification or business reason for the transaction"}},"required":["correlationId","preferredAddressId","effectiveDate","address","isAddressSameAsOwner"]},"DeliveryDateSetupRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal"}}},"PartyName":{"type":"object","properties":{"firstName":{"type":"string","description":"First name","example":"John"},"middleName":{"type":"string","description":"Middle name","example":"William"},"lastName":{"type":"string","description":"Last Name","example":"Doe"},"fullName":{"type":"string","description":"Full Name","example":"John William Doe"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"doingBusinessAs":{"type":"string","description":"Doing Business As","example":"TPA"},"abbreviatedName":{"type":"string","description":"Abbreviated Name","example":"AG"}}},"PartyNameChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")","format":"date"},"partyType":{"$ref":"#/components/schemas/PartyType"},"partyName":{"$ref":"#/components/schemas/PartyName"}}},"BankAccountChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"},"bankAccount":{"$ref":"#/components/schemas/BankAccountBase"}}},"CommunicationPreferenceCommunicationPreference":{"type":"object","properties":{"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"text":{"type":"string","example":"OTHER","description":"If type OTHER, then provide further info using text."}}},"CommunicationPreference":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"format":"date","type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"communicationPreference":{"$ref":"#/components/schemas/CommunicationPreferenceCommunicationPreference"}}},"PartyChangeRequestParty":{"type":"object","properties":{"partyType":{"$ref":"#/components/schemas/PartyType"},"partyRoleId":{"type":"string","description":"TBD"},"parentPartyId":{"type":"string","description":"The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)","example":"1"},"beneficiaryPercentage":{"type":"number","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary","example":100,"format":"double"},"agentPercentage":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent","example":100},"agentExternalId":{"type":"string","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent","example":"3160000751"},"agentType":{"$ref":"#/components/schemas/AgentType"},"firstName":{"type":"string","description":"The first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"The middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"The last name of the party/trustee","example":"Bates"},"fullName":{"type":"string","description":"The full name of the party/The legal name of the Trust/Organization","example":"Karen Anne Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"gender":{"$ref":"#/components/schemas/Gender"},"dateOfBirth":{"type":"string","description":"The date of birth of the party","format":"date","example":"2023-01-01"},"genderIdentity":{"type":"string","description":"Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy","example":"TBD"},"attainedAge":{"type":"integer","description":"Age calculated by date of birth and Policy year","format":"int32","example":55},"birthCountry":{"$ref":"#/components/schemas/Country"},"citizenCountry":{"$ref":"#/components/schemas/Country"},"birthState":{"$ref":"#/components/schemas/State"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"TBD"},"entityType":{"$ref":"#/components/schemas/EntityType"},"trustDate":{"type":"string","description":"The trust agreement issued date to the party","format":"date","example":"2023-01-01"},"amendedTrustDate":{"type":"string","description":"The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy","format":"date","example":"2023-01-01"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"},"trustType":{"$ref":"#/components/schemas/TrustType"},"trustTitle":{"type":"string","description":"The title of the trustee","example":"TBD"},"trustAccessCode":{"type":"string","description":"Access code of the trustee","example":"TBD"},"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"preferredAddressId":{"type":"string","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping","example":"1"},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file","example":"1"},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"partyPercentage":{"type":"number","format":"double","description":"Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties","example":12.1213,"deprecated":true},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"taxWithholdings":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"},"isPartyBeneficiaryNonNatural":{"type":"boolean","description":"A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities"},"isIrrevocable":{"type":"boolean","description":"An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms"},"isRequiredMinimumDistributionDesignated":{"type":"boolean","description":"An indicator if the beneficiary is designated to be included in Joint RMD calculations"},"lastContactDate":{"type":"string","format":"date","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","example":"2023-01-01"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request."},"delegatedExecutionAuthorityType":{"$ref":"#/components/schemas/DelegatedExecutionAuthorityType"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressBase"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/PhoneBase"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailBase"}},"bankDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountBase"}},"startDate":{"type":"string","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"Date (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"beneficiaryAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}},"partyAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}}}},"PartyChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"5df63b47-54fc-4905-a8ff-e1c5f12e667d","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date the Party was added to the Policy"},"customerId":{"type":"string","description":"Assigned by Sales Force and used by all platforms","example":"0017b000010N4bCAAS"},"relationshipToInsured":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","LIFEPARTNER","MOTHER","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","GRANDPARENT","PARENT","OWNER","SIBLING","STEPCHILD","STEPARENT","OTHER","AUNT","GRANDFATHER","GRANDMOTHER","HUSBAND","WIFE","UNCLE","NIECE","NEPHEW","ESTATE","TRUST","GRANDSON","GRANDDAUGHTER","NONSPOUSE","CHILDRENEQUALLY","CHILDRENPERSTIRPES","PERSTIRPES","SURVIVINGSPOUS","COMORTGAGER","DEPENDENT"],"description":"The type of relationship to the party"},"relationshipToParty":{"type":"string","enum":["TRUSTEE","TRUSTEEOFMINOR","TRUSTEEOFINCOMPETENT","POWEROFATTORNEY","CONTROLLINGPERSONOFENTITY","BROTHER","CHILD","DAUGHTER","DOMESTICPARTNER","EXECUTORS","FATHER","FIANCE","GRANDCHILD","LIFEPARTNER","MOTHER","SISTER","SON","SPOUSE","STEPFATHER","STEPMOTHER","SELF","LEGALGUARDIAN","BUSINESS","BUSINESSASSOCIATE","PARTNER","EMPLOYER","FORMERSPOUSE","GRANDPARENT","PARENT","OWNER","SIBLING","STEPCHILD","STEPARENT","OTHER","AUNT","GRANDFATHER","GRANDMOTHER","HUSBAND","WIFE","UNCLE","NIECE","NEPHEW","ESTATE","TRUST","GRANDSON","GRANDDAUGHTER","NONSPOUSE","CHILDRENEQUALLY","CHILDRENPERSTIRPES","PERSTIRPES","SURVIVINGSPOUS","COMORTGAGER","DEPENDENT"],"description":"The type of relationship to the party"},"party":{"$ref":"#/components/schemas/PartyChangeRequestParty"}}},"PartyRoles":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyRoleId":{"type":"string","description":"The Party Role ID is a unique identifier assigned to a specific role that a party (individual or entity) plays within an insurance or annuity contract. It serves to distinctly track and manage the relationship between the party and the contract, especially when a party may have multiple roles across different policies or within the same policy"},"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"Party_PI_1"},"startDate":{"type":"string","description":"Date the Party was added to the Policy","example":"2023-01-01","format":"date"},"endDate":{"type":"string","description":"Date the Party was Terminated from the Policy","example":"2023-01-01","format":"date"}}},"PolicySummary":{"type":"object","properties":{"id":{"type":"string","description":"Internal ID of the snapshot document","example":"657bddcddc353e5fc5f45acd"},"event":{"type":"string","description":"The transaction type of the current policy snapshot","example":"InterestCreditMatch"},"effectiveDate":{"type":"string","description":"Policy as of effective date, (with pattern \"yyyy-mm-dd\")","example":"2023-01-01","format":"date"},"policyNumber":{"type":"string","description":"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":"POLICY1234567890"},"carrierId":{"type":"string","description":"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":"EVGL"},"product":{"$ref":"#/components/schemas/Product"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"Qualification type of original policy being exchanged"},"qualificationPlanTypeDescription":{"type":"string","description":"TBD","example":"Qualification description"},"policyStatus":{"$ref":"#/components/schemas/PolicyStatus"},"restrictStatus":{"$ref":"#/components/schemas/RestrictStatus"},"issueState":{"$ref":"#/components/schemas/State"},"policyDates":{"$ref":"#/components/schemas/PolicyDates"},"currency":{"$ref":"#/components/schemas/Currency"},"testValues":{"$ref":"#/components/schemas/TestValues"},"marketValueAdjustmentProduct":{"type":"boolean","description":"Flag to identify whether the contract is MVA product or not"},"accountValues":{"$ref":"#/components/schemas/AccountValues"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PartyRoles"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/Parties"}}}},"InitialPremiumRequestTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","example":1000.31,"description":"Requested amount value","format":"double"},"netPaymentAmount":{"type":"number","example":48000.52,"description":"The net amount actually received from the agent to be applied to the policy","format":"double"}}},"FundAllocationAllocationOption":{"type":"object","properties":{"allocationOption":{"$ref":"#/components/schemas/AllocationOption"}}},"InitialPremiumRequestPayor":{"type":"object","properties":{"partyId":{"type":"string","example":"Party_PI_1","description":"Impacted Party in the event of financial transaction"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"bankId":{"type":"string","example":"Bank_1","description":"Comes in Acord 103"}}},"AdhocDisbursementParty":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","description":"A unique identifier for the financial institution handling the transaction","example":"Bank_1"},"addressId":{"type":"string","description":"A unique identifier for the address associated with the payee or policyholder","example":"1"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."}}},"AdhocExternalIdentifiers":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"The unique payment reference number for all premium-related"},"externalTransactionId":{"type":"string","description":"The unique ID to identify transaction on carrier side"}}},"InitialPremiumRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal"},"transactionReason":{"type":"string","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","FACEINCREASECOVERAGE","MECAUTHORIZATION","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS","DATEOFDEATH","INITIALDEATHNOTIFICATION","PRODUCTDEFAULT","GWBRIDERDISBURSEMENT","GWBPHASECHANGE","PREMIUMLOAN","PAYMENTDUEDATE"],"description":"The justification or business reason for the transaction"},"transactionAmounts":{"$ref":"#/components/schemas/InitialPremiumRequestTransactionAmounts"},"fundAllocation":{"$ref":"#/components/schemas/FundAllocationAllocationOption"},"exchange":{"$ref":"#/components/schemas/TransactionExchange"},"taxBasis":{"$ref":"#/components/schemas/TransactionTaxBasis"},"payor":{"$ref":"#/components/schemas/InitialPremiumRequestPayor"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"FreeLookCancellationRequestTransactionAmounts":{"type":"object","properties":{"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy or account associated with the transaction for DTCC money movement."},"participantId":{"type":"string","example":"DTCC12345","description":"The DTCC Participant ID (also known as DTCC Number or Participant Number) assigned by DTCC to financial institutions."}}},"Charge":{"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/TransactionChargeType"},"chargeWaiverIndicator":{"$ref":"#/components/schemas/ChargeWaiverIndicator"},"chargeWaiverReason":{"type":"string","description":"The reason why a charge was waived (e.g., Promotional Waiver, Policy Exception)","example":"100"},"partyId":{"type":"string","description":"The partyId to which the charge is applied.","example":"Party_PI_1"}}},"PayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction"}},"required":["allocationPercentage"]},"FreeLookCancellationRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day"},"transactionAmounts":{"$ref":"#/components/schemas/FreeLookCancellationRequestTransactionAmounts"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"payeeOrBeneficiary":{"$ref":"#/components/schemas/PayeeOrBeneficiary"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"FreeLookCancellationQuoteTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","description":"Depending on the transaction, it will be one of the following:\n\nThe amount requested for premium allocation or processing.\n\nThe requested amount for issuing a new loan against the policy.\n\nThe amount requested to initiate a loan repayment transaction.\n\nThe requested amount for a partial withdrawal from the policy's cash value.\n\nThe requested amount for making adjustments to the policy's value. This transaction overrides the value and do not adjust.\n\nRequest amount shared for this variable will be utilized to override existing policy variable."},"appliedAmount":{"type":"number","description":"Depending on the transaction, it will be one of the following:\n\nThe portion of the requested premium that was successfully applied to the account value of the policy.\n\nThe portion of the requested loan amount that was actually applied on the policy.\n\nThe portion of the requested loan repayment amount that was applied on the policy.\n\nThe portion of the requested withdrawal amount that was applied on the policy.\n\nThe total amount applied toward the full surrender of the policy.\n\nThe portion of a transaction applied amount that is summation of all fund level applied amounts impacted due to the transaction.\n\nThe updated face amount successfully applied to the policy.\n\nThe amount refunded as part of a free-look period cancellation (policy cancellation within the allowable period).\n\nThe policy's value before an adjustment is applied."},"taxableAmount":{"type":"number","description":"The portion of a transaction applied amount that is considered taxable based on IRS regulations"},"netPaymentAmount":{"type":"number","description":"The net amount actually received from the agent to be applied to the policy"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"}}},"FreeLookCancellationQuotePayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction"},"disbursementAmount":{"type":"number","example":20,"description":"The actual dollar amount disbursed to the payee"}},"required":["allocationPercentage"]},"TaxWithholdingInstructions":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"partyRole":{"type":"string","enum":["OWNER","PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY","INSURED","PAYOR","PAYEE","AGENT","PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT","THIRDPARTYDESIGNEE","JOINTOWNER","COVERAGEINSURED","ASSIGNEE","ANNUITANT","EXCHANGECOMPANY","JOINTANNUITANT","GRANTOR","TRUSTEE","POWEROFATTORNEY","AUTHORIZEDSIGNATORY","OTHERINTERESTEDPARTY","CONTINGENTOWNER","THIRDPARTYADMINISTRATOR","CARRIER","SUCCESSORTRUSTEE","COVERAGEJOINTINSURED"],"description":"Roles that are essential in structuring life insurance and annuity contracts to meet the financial goals of policyholders and beneficiaries"},"taxWithholdingType":{"$ref":"#/components/schemas/TaxWithholdingType"},"taxRateToUse":{"$ref":"#/components/schemas/TaxRateToUse"},"filingStatus":{"$ref":"#/components/schemas/FilingStatus"},"dollar":{"type":"number","description":"The amount portion of the taxable transaction amount to be withheld","example":10,"format":"double"},"percentage":{"type":"number","description":"The percentage of the taxable transaction amount to be withheld","example":50,"format":"double"},"exemptions":{"type":"number","description":"The number of exemptions claimed for tax withholding within a tax year","example":0,"format":"int32"},"taxJurisdiction":{"type":"string","description":"The legal tax authority (state or federal) governing the withholding process","example":"USA_WY"},"contribution":{"type":"string","enum":["NOTAPPLICABLE","EMPLOYEEVOLUNTARY","EMPLOYEEDISCRETIONARY"],"description":"Not applicable, Employee Voluntary and Employee Discretionary"},"taxFormType":{"type":"string","enum":["T1035COSTBASIS","T1035LOANTRANSFER","T1035SURRENDER","T1035TAXADVANTAGE","T1099R","TAXDISCLOSUREFORMW4P","TAXDISCLOSUREFORMW8","USW4TAXFORM","W9","VOIDCHECK"],"description":"The Tax Form Type refers to the specific IRS or government form used as the basis for determining an individual’s or entity’s tax withholding status on financial products such as life insurance policies, annuities, or investment accounts"},"w4p":{"$ref":"#/components/schemas/W4P"}}},"BasePolicy":{"type":"object","properties":{"id":{"type":"string","description":"Internal ID of the snapshot document","example":"657bddcddc353e5fc5f45acd"},"event":{"type":"string","description":"The transaction type of the current policy snapshot","example":"InterestCreditMatch"},"effectiveDate":{"type":"string","format":"date","description":"Policy as of effective date (with pattern \"yyyy-mm-dd\").","example":"2023-01-01"},"carrierId":{"type":"string","description":"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":"EVGL"},"policyReferenceId":{"type":"string","description":"Attribute name storing the policy reference id generated by RDE system","example":"563f35b74b904f87a2e3ddbde0c3c541"},"thirdPartyAdministratorId":{"type":"string","description":"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"},"policySource":{"type":"string","description":"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"},"policySourceDescription":{"type":"string","description":"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"},"product":{"$ref":"#/components/schemas/Product"},"banding":{"type":"string","enum":["NOPREMIUMBANDING"],"description":"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"},"matchBonusVersion":{"type":"string","description":"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"},"packageId":{"type":"string","description":"Package Id identifies the investment package applicable to the policy, defining the funds and investment options available. The package is determined at the policy level and may change in response to policy events or configuration changes.","example":"1"},"qualificationType":{"type":"string","enum":["INDIVIDUALRETIREMENTACCOUNTREGULAR","INDIVIDUALRETIREMENTACCOUNTSPOUSAL","INDIVIDUALRETIREMENTACCOUNTROLLOVER","ROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT","CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT","QUALIFIED","NONQUALIFIED","SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT","INHERITEDINDIVIDUALRETIREMENTACCOUNT","INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT","NONQUALIFIEDSTRETCH","INDIVIDUALRETIREMENTACCOUNTSIMPLE","Q403B","Q401K","Q401A","Q457B","PENSIONPLAN","CONVERTEDINDIVIDUALRETIREMENTACCOUNT","ROTH403B","CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION","KEOGH10","CORPORATEPENSION","GROUPTAXSHELTEREDANNUITY","PROFITSHARING","TARGETBENEFIT","CORPORATEDEFERREDCOMPENSATION404","EDUCATIONALINDIVIDUALRETIREMENTACCOUNT","QN457B","CONVERTED","SPOUSAL","CUSTODIAL","UNIFORMGIFTSORTRANSFERSTOMINORACT","CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT","MONEYPURCHASEPENSIONPLAN","Q401G","Q412E3","QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT","ROTH401K","VARIABLEUNIVERSALLIFENONQUALIFIED"],"description":"Qualification type of original policy being exchanged"},"policyTerm":{"type":"number","format":"int32","description":"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},"policyYear":{"type":"number","format":"int32","description":"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},"monthOfYear":{"type":"number","format":"int32","description":"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},"policyNumber":{"type":"string","description":"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":"POLICY1234567890"},"parentPolicyNumber":{"type":"string","description":"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":"POLICY12345"},"priorPolicyNumber":{"type":"string","description":"The unique identifier of the original policy number of a policy in the case of a conversion, replacement, exchange or reissue","example":"POLICY123450"},"policyStatus":{"$ref":"#/components/schemas/PolicyStatus"},"restrictStatus":{"$ref":"#/components/schemas/RestrictStatus"},"issueType":{"$ref":"#/components/schemas/IssueType"},"issueState":{"$ref":"#/components/schemas/State"},"currency":{"$ref":"#/components/schemas/Currency"},"policyDates":{"$ref":"#/components/schemas/PolicyDates"},"costBasis":{"$ref":"#/components/schemas/CostBasis"},"fixedCostPeriod":{"type":"number","format":"int32","example":10,"description":"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"},"fixedCostPeriodOption":{"type":"number","format":"int64","description":"Option for fixed cost period calculation","example":1},"fixedCostPeriodUnit":{"$ref":"#/components/schemas/FixedCostPeriodUnit"},"fixedCostPolicyYearEnd":{"type":"number","format":"int32","example":2,"description":"This field will be calculated for each policy. If unit is Years, this field can be equal to Fixed Cost Period. If unit is AGE, then the calculation will be Fixed Cost Period minus Issue Age."},"fixedCostPeriodEndYear":{"type":"number","format":"int32","example":10,"description":"The calculated end year of the Fixed Cost Period. If fixedCostPeriodUnit is YEARS, this equals fixedCostPeriod. If fixedCostPeriodUnit is AGE, this is calculated as fixedCostPeriod minus Issue Age. This field is calculated by LPS for each policy."},"commissionOption":{"$ref":"#/components/schemas/CommissionOption"},"accountValues":{"$ref":"#/components/schemas/AccountValues"},"loanValues":{"$ref":"#/components/schemas/LoanValues"},"withdrawalValues":{"$ref":"#/components/schemas/WithdrawalValues"},"marketValueAdjustment":{"$ref":"#/components/schemas/MarketValueAdjustment"},"requiredMinimumDistribution":{"$ref":"#/components/schemas/RequiredMinimumDistribution"},"testValues":{"$ref":"#/components/schemas/TestValues"},"timestamp":{"type":"string","format":"date-time","example":"2023-01-01T12:00:00.000Z"},"deathBenefit":{"$ref":"#/components/schemas/DeathBenefit"},"coverage":{"$ref":"#/components/schemas/PolicyCoverage"},"riders":{"type":"array","items":{"$ref":"#/components/schemas/Rider"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/PolicyCharges"}},"systematicPrograms":{"type":"array","items":{"$ref":"#/components/schemas/SystematicProgram"}},"policyFeatures":{"type":"array","items":{"$ref":"#/components/schemas/PolicyFeature"}},"allocation":{"$ref":"#/components/schemas/Distribution"},"surplusDistribution":{"$ref":"#/components/schemas/PolicySnapshotSurplusDistribution"},"version":{"type":"integer","format":"int32","description":"Version number","example":1},"policyContractState":{"$ref":"#/components/schemas/PolicyContractState"}}},"FreeLookCancellationQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"transactionAmounts":{"$ref":"#/components/schemas/FreeLookCancellationQuoteTransactionAmounts"},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/FreeLookCancellationQuotePayeeOrBeneficiary"}},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithheldAmount"}},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"FundAllocationsChangeRequestFundAllocationsInvestments":{"type":"object","properties":{"fundId":{"type":"string","description":"TBD","example":"FundAccount1"},"allocationPercentage":{"type":"number","format":"double","description":"At Policy Level for Each Applicable Funds (Everly there is only one Fixed) Therefore this be 100%","example":100},"startDate":{"type":"string","format":"date","description":"TBD","example":"2024-01-01"}}},"FundAllocationsChangeRequestAllocation":{"type":"object","properties":{"investmentType":{"$ref":"#/components/schemas/InvestmentType"},"modelId":{"type":"string","description":"The corresponding model id of the elected model","example":"TBD"},"fundAllocationsInvestments":{"type":"array","items":{"$ref":"#/components/schemas/FundAllocationsChangeRequestFundAllocationsInvestments"}}}},"FundAllocationsChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string"},"effectiveDate":{"type":"string","format":"date","example":"2024-01-01"},"reverseInitiator":{"type":"boolean","default":false},"allocation":{"$ref":"#/components/schemas/FundAllocationsChangeRequestAllocation"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"AmountTypes":{"type":"object","properties":{"amountType":{"$ref":"#/components/schemas/AmountType"}}},"AdhocFundTransferFundSegment":{"type":"object","properties":{"segmentId":{"type":"string"},"requestedAmount":{"type":"number","format":"double","example":124.124213}}},"AdhocFundTransferFromFund":{"type":"object","properties":{"fundId":{"type":"string"},"requestedAmount":{"type":"number","format":"double","example":124.124213},"fundSegments":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundTransferFundSegment"}}}},"AdhocFundTransferToFund":{"type":"object","properties":{"fundId":{"type":"string"},"requestedAmount":{"type":"number","format":"double","example":124.124213},"fundSegments":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundTransferFundSegment"}}}},"FundTransferRequestFunds":{"type":"object","properties":{"transferFrom":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundTransferFromFund"}},"transferTo":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundTransferToFund"}}}},"FundTransferRequest":{"type":"object","properties":{"correlationId":{"type":"string"},"effectiveDate":{"type":"string","format":"date"},"reverseInitiator":{"type":"boolean"},"transactionAmounts":{"$ref":"#/components/schemas/AmountTypes"},"fundAllocation":{"$ref":"#/components/schemas/FundAllocationAllocationOption"},"funds":{"$ref":"#/components/schemas/FundTransferRequestFunds"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"BaseAdhocParty":{"type":"object","properties":{"partyId":{"type":"string","example":"Party_PI_1","description":"Impacted Party in the event of financial transaction"},"bankId":{"type":"string","example":"Bank_1","description":"Comes in Acord 103"}}},"AdhocFundAllocation":{"type":"object","properties":{"allocationOption":{"$ref":"#/components/schemas/AllocationOption"},"amountType":{"$ref":"#/components/schemas/AmountType"}}},"DistributionAmountType":{"type":"string","enum":["PERCENTAGE","AMOUNT","UNIT"]},"AdhocFundDistributionSegment":{"type":"object","properties":{"segmentId":{"type":"string","description":"A unique identifier assigned to a particular segment for a specific fund account within the investment structure"},"currentAmount":{"type":"number"},"requestedAmount":{"type":"number"}}},"AdhocFundDistributions":{"type":"object","properties":{"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure"},"totalFundValue":{"type":"number","description":"The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction"},"requestedAmount":{"type":"number","description":"The specific amount or percentage requested for withdrawal, transfer, or reallocation from the selected fund.This amount will be utilized when allocation option is selected as specified funds"},"distributionAmountType":{"$ref":"#/components/schemas/DistributionAmountType"},"fundDistributionSegments":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundDistributionSegment"}}}},"AdhocSystematicProgram":{"type":"object","properties":{"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"arrangementType":{"$ref":"#/components/schemas/ArrangementType"},"amountType":{"$ref":"#/components/schemas/AmountType"},"amount":{"type":"number","example":5.132,"description":"Requested amount value","format":"double"},"frequency":{"$ref":"#/components/schemas/Frequency"},"startDate":{"format":"date","type":"string","example":"2020-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"endDate":{"format":"date","type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"previousProgramDate":{"format":"date","type":"string","example":"2018-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"nextProgramDate":{"format":"date","type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"party":{"$ref":"#/components/schemas/BaseAdhocParty"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"externalArrangementId":{"type":"string","description":"The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program"},"segmentId":{"type":"string","description":"A unique identifier assigned to a specific loan segment","example":"Segment1"},"accountNumber":{"type":"string","description":"The unique identifier representing the policy or account associated with the transaction for DTCC money movement.","example":"123456789"},"participantId":{"type":"string","description":"The DTCC Participant ID (also known as DTCC Number or Participant Number) assigned by DTCC to financial institutions.","example":"DTCC12345"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundDistributions"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"SystematicProgramSetupRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","example":true,"default":false,"description":"Property to isolate source transaction(s) that initiated the reversal"},"systematicProgram":{"$ref":"#/components/schemas/AdhocSystematicProgram"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"SystematicProgramUpdateRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","example":true,"default":false,"description":"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"},"arrangementId":{"type":"string","example":"Arr_1","description":"The unique payment number for payments by the party"},"systematicProgram":{"$ref":"#/components/schemas/AdhocSystematicProgram"}}},"Payee":{"type":"object","properties":{"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions","example":"Party_PI_1"},"percentage":{"type":"number"},"bankId":{"type":"string"}},"required":["partyId","percentage","bankId"]},"PolicyWithdrawal":{"type":"object","properties":{"allocationOptionType":{"type":"string"},"disbursementType":{"type":"string"},"frequency":{"type":"string"},"effectiveDate":{"type":"string"},"amountType":{"type":"string"},"amount":{"type":"number"},"payees":{"type":"array","items":{"$ref":"#/components/schemas/Payee"}},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}}},"required":["allocationOptionType","disbursementType","frequency","effectiveDate","amountType","amount","payees","taxWithholdingInstructions"]},"FinancialTransactionTransactionTypeEnum":{"type":"string","enum":["PartialWithdrawalOneTime","FullSurrender","NewLoan","OneTimePremium","SystematicProgramUpdate","LoanRepaymentOneTime","SystematicLoanRepaymentSetup"]},"BankDetails":{"type":"object","properties":{"recordId":{"type":"number"},"appliesToPartyId":{"type":"string"},"financialInstitutionPartyId":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"nameOnAccount":{"type":"string"},"accountStatus":{"type":"string"},"accountType":{"type":"string"},"accountNumber":{"type":"string"},"routingNumber":{"type":"string"},"ibaNumber":{"type":"string"},"branchName":{"type":"string"},"accountPurpose":{"type":"string"},"branchAddress":{"$ref":"#/components/schemas/Address"},"branchPhoneNumber":{"type":"string"}},"required":["recordId","appliesToPartyId","financialInstitutionPartyId","startDate","endDate","nameOnAccount","accountStatus","accountType","accountNumber","routingNumber","ibaNumber","branchName","accountPurpose","branchAddress","branchPhoneNumber"]},"RiskDetails":{"type":"object","properties":{"existingLifeInsurance":{"type":"boolean"},"existingLifeInsuranceAmount":{"type":"number"},"replaceLifeInsurance":{"type":"boolean"},"pendingOrPlanToBuyAdditional":{"type":"boolean"},"isDependent":{"type":"boolean"},"employed":{"type":"boolean"},"employmentStatus":{"type":"string"},"occupation":{"type":"string"},"householdIncome":{"type":"number"}},"required":["existingLifeInsurance","existingLifeInsuranceAmount","replaceLifeInsurance","pendingOrPlanToBuyAdditional","isDependent","employed","employmentStatus","occupation","householdIncome"]},"Payor":{"type":"object","properties":{"id":{"type":"string"},"policyDetailsId":{"type":"string"},"ledgerDocId":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"policyNumber":{"type":"string"},"partyMasterId":{"type":"string"},"partyId":{"type":"string"},"idReferenceNo":{"type":"string"},"beneficiaryPercentage":{"type":"number"},"partyType":{"type":"string"},"url":{"$ref":"#/components/schemas/Url"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"fullName":{"type":"string"},"prefix":{"type":"string"},"suffix":{"type":"string"},"gender":{"type":"string"},"dateOfBirth":{"type":"string"},"attainedAge":{"type":"number"},"birthCountry":{"type":"string"},"birthState":{"type":"string"},"dba":{"type":"string"},"abbrName":{"type":"string"},"orgCode":{"type":"string"},"entityType":{"type":"string"},"trustDate":{"type":"string"},"trustType":{"type":"string"},"prefCommunicationType":{"type":"string"},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"bankDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankDetails"}},"dateOfDeath":{"type":"string"},"stateOfDeath":{"type":"string"},"disabled":{"type":"boolean"},"disabilityStartDate":{"type":"string"},"riskDetails":{"$ref":"#/components/schemas/RiskDetails"},"financialInstitutionPartyId":{"type":"string"},"percentage":{"type":"number"},"version":{"type":"number"}},"required":["id","policyDetailsId","ledgerDocId","timestamp","policyNumber","partyMasterId","partyId","idReferenceNo","beneficiaryPercentage","partyType","url","firstName","middleName","lastName","fullName","prefix","suffix","gender","dateOfBirth","attainedAge","birthCountry","birthState","dba","abbrName","orgCode","entityType","trustDate","trustType","prefCommunicationType","formerName","identifications","addresses","phones","emails","bankDetails","dateOfDeath","stateOfDeath","disabled","disabilityStartDate","riskDetails","financialInstitutionPartyId","percentage","version"]},"FinancialTransactionRequestTypeEnum":{"type":"string","enum":["Quote","Actual"]},"CaseRequest":{"type":"object","properties":{"caseCorrelationId":{"type":"string"},"caseId":{"type":"string"},"caseStatus":{"type":"string"},"requestSource":{"type":"string"},"carrierId":{"type":"string"},"productId":{"type":"string"},"userId":{"type":"string"},"policyNumber":{"type":"string"}},"required":["caseCorrelationId","caseId","caseStatus","requestSource","carrierId","productId","userId","policyNumber"]},"CaseResponse":{"type":"object","properties":{"caseErrorCode":{"type":"string"},"caseErrorDescription":{"type":"string"}},"required":["caseErrorCode","caseErrorDescription"]},"Schedule":{"type":"object","properties":{"amountType":{"type":"string"},"amount":{"type":"number"},"nextProgramDate":{"type":"string"}},"required":["amountType","amount","nextProgramDate"]},"RemovePayor":{"type":"object","properties":{"partyRole":{"type":"string"},"partyId":{"type":"string"}},"required":["partyRole","partyId"]},"FinancialTransaction":{"type":"object","properties":{"id":{"type":"string"},"policyDetailsId":{"type":"string"},"ledgerDocId":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"policyNumber":{"type":"string"},"transactionId":{"type":"string"},"externalTransactionId":{"type":"string"},"correlationId":{"type":"string"},"parentId":{"type":"string"},"transType":{"type":"string"},"transactionType":{"$ref":"#/components/schemas/FinancialTransactionTransactionTypeEnum"},"requestDate":{"type":"string"},"effectiveDate":{"type":"string"},"processDate":{"type":"string"},"status":{"type":"string"},"action":{"type":"string"},"outcome":{"type":"boolean"},"outcomeStatus":{"type":"string"},"outcomeCode":{"type":"string"},"outcomeCodeDescription":{"type":"string"},"transactionReason":{"type":"string"},"processNo":{"type":"number"},"transactionAmounts":{"$ref":"#/components/schemas/TransactionAmount"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"fundAllocation":{"$ref":"#/components/schemas/TransactionFundAllocation"},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/FundDistribution"}},"fundActivity":{"type":"array","items":{"$ref":"#/components/schemas/FundActivity"}},"matchActivity":{"$ref":"#/components/schemas/MatchActivity"},"loanActivity":{"$ref":"#/components/schemas/LoanActivity"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithheldAmount"}},"payor":{"type":"array","items":{"$ref":"#/components/schemas/Payor"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/PayeeOrBeneficiary"}},"lifecycleNo":{"type":"number"},"reverseInitiator":{"type":"boolean","default":false},"caseId":{"type":"string"},"partyId":{"type":"string"},"requestType":{"$ref":"#/components/schemas/FinancialTransactionRequestTypeEnum"},"caseRequest":{"$ref":"#/components/schemas/CaseRequest"},"caseResponse":{"$ref":"#/components/schemas/CaseResponse"},"programType":{"type":"string"},"systematicProgramId":{"type":"string"},"frequency":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"schedule":{"$ref":"#/components/schemas/Schedule"},"removePayor":{"$ref":"#/components/schemas/RemovePayor"},"version":{"type":"string"}},"required":["id","policyDetailsId","ledgerDocId","timestamp","policyNumber","transactionId","externalTransactionId","correlationId","parentId","transType","requestDate","effectiveDate","processDate","status","action","outcome","outcomeStatus","outcomeCode","outcomeCodeDescription","transactionReason","processNo","transactionAmounts","charges","fundAllocation","fundDistributions","fundActivity","matchActivity","loanActivity","taxWithholdingInstructions","taxWithheldAmounts","payor","payeeOrBeneficiary","lifecycleNo","caseId","partyId","caseRequest","caseResponse","programType","systematicProgramId","frequency","startDate","endDate","schedule","removePayor","version"]},"PartialWithdrawalTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number"},"amountType":{"$ref":"#/components/schemas/AmountType"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy number associated with a transaction for DTCC money movement."},"participantId":{"type":"string","example":"123456789","description":"The DTCC Participant ID (also known as a DTCC Number or Participant Number) is a unique identifier assigned by the Depository Trust & Clearing Corporation (DTCC) to financial institutions — such as broker-dealers, banks, or mutual funds — that participate in DTCC’s clearing and settlement systems."}}},"PartialWithdrawalOneTimeRequest":{"type":"object","properties":{"correlationId":{"type":"string"},"effectiveDate":{"type":"string","format":"date"},"reverseInitiator":{"type":"boolean","default":false},"transactionAmounts":{"$ref":"#/components/schemas/PartialWithdrawalTransactionAmounts"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundDistributions"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/PayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"PartialWithdrawalQuoteTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","format":"double","example":10},"appliedAmount":{"type":"number","format":"double","example":10},"taxableAmount":{"type":"number","format":"double","example":10},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"totalChargeAmount":{"type":"number","format":"double","example":10}}},"PartialWithdrawalQuotePayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number"},"bankId":{"type":"string"},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","example":20}}},"PartialWithdrawalOneTimeQuoteResponseParties":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","description":"A unique identifier for the financial institution handling the transaction","example":"Bank_1"},"addressId":{"type":"string","description":"A unique identifier for the address associated with the payee or policyholder","example":"1"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","example":20,"description":"TBD"}}},"PartialWithdrawalOneTimeQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"transactionAmounts":{"$ref":"#/components/schemas/PartialWithdrawalQuoteTransactionAmounts"},"charges":{"$ref":"#/components/schemas/Charge"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithholdingInstructions"}},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundDistributions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithheldAmount"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/PartialWithdrawalQuotePayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/PartialWithdrawalOneTimeQuoteResponseParties"}},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"OneTimePremiumTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","example":1000.32,"description":"Requested amount value","format":"double"},"appliedAmount":{"type":"number","example":1000.43,"format":"double","description":"The portion of the requested loan amount that was actually applied on the policy"},"netPaymentAmount":{"type":"number","example":48000.21,"format":"double","description":"The net amount actually received from the agent to be applied to the policy"},"imageNumber":{"type":"string","description":"Internal identifier to track document number.","example":"IMG12345"}}},"TransactionReason":{"type":"string","description":"The specific reason or purpose for the transaction being processed","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","FACEINCREASECOVERAGE","MECAUTHORIZATION","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS","DATEOFDEATH","INITIALDEATHNOTIFICATION","PRODUCTDEFAULT","GWBRIDERDISBURSEMENT","GWBPHASECHANGE","PREMIUMLOAN","PAYMENTDUEDATE"]},"OneTimePremiumPayor":{"type":"object","properties":{"partyId":{"type":"string","example":"Party_PI_1","description":"Impacted Party in the event of financial transaction"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"bankId":{"type":"string","example":"Bank_1","description":"Comes in Acord 103"}}},"OneTimePremiumRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day","format":"date"},"reverseInitiator":{"type":"boolean","example":false,"default":false,"description":"Property to isolate source transaction(s) that initiated the reversal"},"transactionAmounts":{"$ref":"#/components/schemas/OneTimePremiumTransactionAmounts"},"transactionReason":{"$ref":"#/components/schemas/TransactionReason"},"payor":{"$ref":"#/components/schemas/OneTimePremiumPayor"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"exchange":{"$ref":"#/components/schemas/TransactionExchange"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"OneTimePremiumQuoteTransactionAmount":{"type":"object","properties":{"requestedAmount":{"type":"number","example":100,"description":"The initial premium amount (deposit amount) paid by the party","format":"double"},"appliedAmount":{"type":"number","example":100,"description":"The initial premium amount that is actually applied to the policy","format":"double"},"calculatedAmount":{"type":"number","example":100,"description":"The amount calculated by the LPS if the issuance transaction outcome fails","format":"double"}}},"OneTimePremiumQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"transactionAmounts":{"$ref":"#/components/schemas/OneTimePremiumQuoteTransactionAmount"},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"AdhocTransactionAmount":{"type":"object","properties":{"requestedAmount":{"type":"number","format":"double","example":1000,"description":"The initial premium amount (deposit amount) paid by the party"},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"loanType":{"$ref":"#/components/schemas/LoanType"},"loanInterestType":{"$ref":"#/components/schemas/LoanInterestType"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy or account associated with the transaction for DTCC money movement."},"participantId":{"type":"string","example":"DTCC12345","description":"The DTCC Participant ID (also known as DTCC Number or Participant Number) assigned by DTCC to financial institutions."}}},"NewLoanRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal","default":false},"transactionAmounts":{"$ref":"#/components/schemas/AdhocTransactionAmount"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithholdingInstructions"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/PayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"NewLoanQuoteTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number"},"appliedAmount":{"type":"number"},"taxableAmount":{"type":"number"},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"}}},"NewLoanQuotePayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string"},"allocationPercentage":{"type":"number"},"bankId":{"type":"string"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","example":20}}},"NewLoanQuoteParty":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","description":"A unique identifier for the financial institution handling the transaction","example":"Bank_1"},"addressId":{"type":"string","description":"A unique identifier for the address associated with the payee or policyholder","example":"1"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","description":"TBD","format":"double","example":20}}},"NewLoanQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","description":"The unique ID to track transaction request across all systems","example":"657b717b7dcf554abf9ef067"},"transactionAmounts":{"$ref":"#/components/schemas/NewLoanQuoteTransactionAmounts"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithheldAmount"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/NewLoanQuotePayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/NewLoanQuoteParty"}},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"RequestedAmount":{"type":"object","properties":{"requestedAmount":{"type":"number","example":1000,"description":"Requested amount value"}}},"LoanRepaymentFundAllocation":{"type":"object","properties":{"allocationOption":{"$ref":"#/components/schemas/AllocationOption"}}},"AdhocParty":{"type":"object","properties":{"partyId":{"type":"string","example":"Party_PI_1","description":"Impacted Party in the event of financial transaction"},"bankId":{"type":"string","example":"Bank_1","description":"Comes in Acord 103"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"}}},"LoanRepaymentOneTimeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day","format":"date"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal","default":false},"transactionAmounts":{"$ref":"#/components/schemas/RequestedAmount"},"fundAllocation":{"$ref":"#/components/schemas/LoanRepaymentFundAllocation"},"payor":{"$ref":"#/components/schemas/AdhocParty"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"LoanRepaymentQuoteTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","example":1000,"description":"Requested amount value"},"appliedAmount":{"type":"number","example":500,"description":"Applied amount value"},"netPaymentAmount":{"type":"number","format":"double","description":"The net amount actually received from the agent to be applied to the policy.","example":48000.28},"taxableAmount":{"type":"number","format":"double","description":"The portion of a transaction applied amount that is considered taxable based on IRS regulations.","example":100.23},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"premiumPortionAmount":{"type":"number","format":"double","description":"The amount paid toward the premium when the policy has a loan balance.","example":1000.51},"loanRepaymentPortionAmount":{"type":"number","format":"double","description":"The amount paid toward the Loan Repayment when the policy has a loan balance.","example":1000.51},"repaymentInterestAmount":{"type":"number","format":"double","description":"The amount of interest repaid as part of transaction. This gets calculated on events such as loan repayment, systematic loan repayment,etc.","example":1000.51}}},"LoanRepaymentOneTimeQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"transactionAmounts":{"$ref":"#/components/schemas/LoanRepaymentQuoteTransactionAmounts"},"fundAllocation":{"$ref":"#/components/schemas/LoanRepaymentFundAllocation"},"payor":{"$ref":"#/components/schemas/AdhocParty"},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"FullSurrenderActualTransactionAmounts":{"type":"object","properties":{"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy number associated with a transaction for DTCC money movement."},"participantId":{"type":"string","example":"123456789","description":"The DTCC Participant ID (also known as a DTCC Number or Participant Number) is a unique identifier assigned by the Depository Trust & Clearing Corporation (DTCC) to financial institutions — such as broker-dealers, banks, or mutual funds — that participate in DTCC’s clearing and settlement systems."}}},"FullSurrenderRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal","default":false},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/PayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"transactionAmounts":{"$ref":"#/components/schemas/FullSurrenderActualTransactionAmounts"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"FullSurrenderQuoteTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","format":"double","example":100},"taxableAmount":{"type":"number","format":"double","example":100},"appliedAmount":{"type":"number","format":"double","example":100},"amountType":{"$ref":"#/components/schemas/AmountType"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"totalChargeAmount":{"type":"number","format":"double","example":10}}},"AdhocTaxWithheldAmount":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","example":"Party_PI_1","description":"A unique identifier linking the party to the policy"},"taxWithholdingType":{"$ref":"#/components/schemas/TaxWithholdingType"},"withheldAmount":{"type":"number","format":"double","example":100,"description":"The actual dollar amount withheld for taxes"},"withheldTaxableAmount":{"type":"number","format":"double","example":100,"description":"The portion of the transaction amount eligible for taxation"},"taxableFlag":{"type":"boolean","description":"Indicates whether the transaction is taxable"}}},"FullSurrenderQuotePayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction"},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","example":20}},"required":["allocationPercentage"]},"FullSurrenderQuoteResponseParties":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","description":"A unique identifier for the financial institution handling the transaction","example":"Bank_1"},"addressId":{"type":"string","description":"A unique identifier for the address associated with the payee or policyholder","example":"1"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."},"disbursementAmount":{"type":"number"},"payeeGrossAmount":{"type":"number","example":20,"description":"TBD"}}},"FullSurrenderOrSystematicProgramQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"transactionAmounts":{"$ref":"#/components/schemas/FullSurrenderQuoteTransactionAmounts"},"charges":{"$ref":"#/components/schemas/Charge"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithheldAmount"}},"payeeOrBeneficiary":{"type":"array","items":{"$ref":"#/components/schemas/FullSurrenderQuotePayeeOrBeneficiary"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/FullSurrenderQuoteResponseParties"}},"policy":{"$ref":"#/components/schemas/BasePolicy"}},"required":["charges"]},"NotificationOfDeathClaimAdhocDeathBenefit":{"type":"object","properties":{"disputedDebtAmount":{"type":"number","example":90,"description":"Amount in question of disagreement between the creditor and the committee as to the existence of a debt or the amount owed by the committee","format":"double"}}},"PartiesDeathNotification":{"type":"object","properties":{"partyId":{"type":"string","description":"Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions.","example":"Party_PB_Primary_Bene_1"},"partyRole":{"$ref":"#/components/schemas/PartyRole"},"deathDetails":{"$ref":"#/components/schemas/DeathDetail"}}},"NotificationOfDeathClaimAdhocPolicy":{"type":"object","properties":{"deathBenefit":{"$ref":"#/components/schemas/NotificationOfDeathClaimAdhocDeathBenefit"},"parties":{"description":"Array of parties involved in the death notification","type":"array","items":{"$ref":"#/components/schemas/PartiesDeathNotification"}}}},"DeathClaimNotification":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day","format":"date"},"reverseInitiator":{"type":"boolean","description":"Property to isolate source transaction(s) that initiated the reversal","default":false},"transactionReason":{"$ref":"#/components/schemas/TransactionReason"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"policy":{"$ref":"#/components/schemas/NotificationOfDeathClaimAdhocPolicy"}}},"DeathClaimTransactionAmounts":{"type":"object","properties":{"claimStatutoryInterestAmount":{"type":"number","example":90,"description":"The statutory interest amount paid as part of a claim settlement. This is the SSI amount","format":"double"},"deathBenefitInterestCalculatedFromDate":{"$ref":"#/components/schemas/DeathBenefitInterestCalculatedFromDate"},"claimStatutoryInterestRate":{"type":"number","example":10,"format":"double","description":"The state specific interest rate applied to the statutory claim payout"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy or account associated with the transaction for DTCC money movement."},"participantId":{"type":"string","example":"DTCC12345","description":"The DTCC Participant ID (also known as DTCC Number or Participant Number) assigned by DTCC to financial institutions."}}},"DeathClaimPayeeOrBeneficiary":{"type":"object","properties":{"partyId":{"type":"string","description":"A unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction"},"partyRole":{"$ref":"#/components/schemas/PartyRole"}},"required":["allocationPercentage"]},"DeathClaimAdhocPolicyDates":{"type":"object","properties":{"claimApprovalDate":{"type":"string","example":"2024-02-21","format":"date","description":"The Claim Approval Date is the date when an insurance company officially approves a claim for payment after verifying the claim details, policy coverage, and required documentation"},"certifiedReceivedDate":{"type":"string","example":"2024-02-21","format":"date","description":"The Certified Received Date refers to the date when the insurance company officially receives the certified death paperwork (such as a death certificate) required to process a life insurance claim. This date marks the beginning of the formal claims verification process"}}},"DeathClaimAdhocDeathBenefit":{"type":"object","properties":{"claimStatus":{"$ref":"#/components/schemas/ClaimStatus"},"proofOfDeathReceived":{"type":"boolean","description":"Whether proof of death is received"}}},"DeathClaimAdhocParty":{"type":"object","properties":{"beneficiaryPercentage":{"type":"number","example":100,"format":"double","description":"The benefit percentage of the beneficiary"},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"}}},"DeathClaimAdhocPolicy":{"type":"object","properties":{"policyDates":{"$ref":"#/components/schemas/DeathClaimAdhocPolicyDates"},"deathBenefit":{"$ref":"#/components/schemas/DeathClaimAdhocDeathBenefit"},"party":{"$ref":"#/components/schemas/DeathClaimAdhocParty"},"charges":{"$ref":"#/components/schemas/Charge"}}},"DeathClaimQuoteTransactionAmounts":{"type":"object","properties":{"disbursementAmount":{"type":"number","format":"double","description":"The actual dollar amount disbursed to the payee.","example":20},"taxableFlag":{"type":"string","description":"Indicates whether the disbursement is taxable.","example":"Y"},"grossAmount":{"type":"number","format":"double","description":"The total gross amount before any deductions or withholdings.","example":20},"partyId":{"type":"string","description":"A unique identifier linking the party to the policy.","example":"Party_PI_1"},"paymentForm":{"type":"string","enum":["DTCC","CREDITCARD","ACH","CHECK","WIRE","EXCHANGE","PREMIUMLOAN"]},"bankId":{"type":"string","example":"Bank_1","description":"A unique identifier for the financial institution handling the transaction."},"partyRole":{"type":"string","enum":["OWNER","PRIMARYBENEFICIARY","CONTINGENTBENEFICIARY","INSURED","PAYOR","PAYEE","AGENT","PRIMARYWRITINGAGENT","PRIMARYSERVICINGAGENT","ADDITIONALSERVICINGAGENT","ADDITIONALWRITINGAGENT","THIRDPARTYDESIGNEE","JOINTOWNER","COVERAGEINSURED","ASSIGNEE","ANNUITANT","EXCHANGECOMPANY","JOINTANNUITANT","GRANTOR","TRUSTEE","POWEROFATTORNEY","AUTHORIZEDSIGNATORY","OTHERINTERESTEDPARTY","CONTINGENTOWNER","THIRDPARTYADMINISTRATOR","CARRIER","SUCCESSORTRUSTEE","COVERAGEJOINTINSURED"],"description":"Party role attached to the transaction"},"allocationPercentage":{"type":"number","format":"double","description":"The percentage of the total disbursement allocated to the payee.","example":100},"addressId":{"type":"string","example":"1","description":"A unique identifier for the address associated with the payee or policyholder."},"forBenefitOfOrForFurtherCredit":{"type":"string","example":"John Doe","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)."}}},"DeathClaimQuotePartyWithDisbursement":{"type":"object","properties":{"partyRole":{"$ref":"#/components/schemas/PartyRole"},"partyId":{"type":"string","description":"unique identifier linking the party to the policy","example":"Party_PI_1"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"allocationPercentage":{"type":"number","description":"The percentage of the total disbursement allocated to the payee","example":100,"format":"double"},"bankId":{"type":"string","description":"A unique identifier for the financial institution handling the transaction","example":"Bank_1"},"addressId":{"type":"string","description":"A unique identifier for the address associated with the payee or policyholder","example":"1"},"forBenefitOfOrForFurtherCredit":{"type":"string","description":"FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)","example":"John Doe"},"forBenefitOfOrForFurtherCreditIndicator":{"type":"boolean","example":true,"description":"Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization."},"disbursementAmount":{"type":"number","format":"double","description":"The actual dollar amount disbursed to the payee.","example":20},"taxableFlag":{"type":"string","description":"Indicates whether the disbursement to this party is taxable.","example":"Y"},"grossAmount":{"type":"number","format":"double","description":"The total gross amount before any deductions or withholdings for this party.","example":20}}},"DeathClaimQuoteDeathDetails":{"type":"object","properties":{"statutoryInterestAmount":{"type":"number","format":"double","description":"The statutory interest amount paid as part of a claim settlement. This is the SSI (Supplemental Security Income) amount.","example":1000.41},"payoutPreSupplementalSecurityIncome":{"type":"number","format":"double","description":"The claim payout amount before applying Supplemental Security Income (SSI) offsets or adjustments.","example":1000.91},"interestCalculationDate":{"type":"string","format":"date","description":"The date from which statutory interest is calculated for the death claim payout.","example":"2023-01-01"},"deathPayoutType":{"type":"string","description":"The type of death benefit payout being processed.","example":"LUMPSUM"}}},"DeathClaimQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"policy":{"$ref":"#/components/schemas/BasePolicy"},"transactionAmounts":{"$ref":"#/components/schemas/DeathClaimQuoteTransactionAmounts"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithholdingInstructions"}},"taxWithheldAmounts":{"type":"array","items":{"$ref":"#/components/schemas/AdhocTaxWithheldAmount"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/DeathClaimQuotePartyWithDisbursement"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"deathClaimDeathDetails":{"$ref":"#/components/schemas/DeathClaimQuoteDeathDetails"}}},"MetricsType":{"type":"string","enum":["LAPSEPROTECTIONPAYMENTAMOUNT","ACCOUNTSURRENDERVALUE","ACCOUNTVALUE","COSTOFINSURANCE","NETDEATHBENEFIT","EXPENSECHARGE","UNITEXPENSECHARGE","INTERESTCREDITRATE","LOANREPAYMENTONETIMEAMOUNT","SYSTEMATICLOANREPAYMENTAMOUNT","INTERESTCREDITAMOUNT","INTERESTLOANAMOUNT","PARTIALWITHDRAWALONETIMEAMOUNT","INITIALPREMIUMAMOUNT","SUBSEQUENTPREMIUMAMOUNT","ONETIMEPREMIUMAMOUNT","NEWLOANAMOUNT","TOTALLOANBALANCE","TOTALCOVERAGEAMOUNT","CUMULATIVEGROSSDEATHBENEFITAMOUNT","CUMULATIVEPREMIUMSINCEISSUE","COVERAGECHARGE","COVERAGECREDIT","INITIALPREMIUMCALCULATEDAMOUNT","SUBSEQUENTPREMIUMCALCULATEDAMOUNT","ONETIMEPREMIUMCALCULATEDAMOUNT","SYSTEMATICWITHDRAWALAMOUNT","FULLSURRENDERCHARGE","PARTIALWITHDRAWALONETIMESURRENDERCHARGE","SYSTEMATICWITHDRAWALSURRENDERCHARGE","REQUIREDMINIMUMDISTRIBUTIONONETIMESURRENDERCHARGE","ANNUITIZATIONPREMIUMTAXCHARGE","DEATHPREMIUMTAXCHARGE","FULLSURRENDERPREMIUMTAXCHARGE","FULLSURRENDERMARKETVALUEADJUSTMENTCHARGE","PARTIALWITHDRAWALONETIMEMARKETVALUEADJUSTMENTCHARGE","SYSTEMATICWITHDRAWALMARKETVALUEADJUSTMENTCHARGE","REQUIREDMINIMUMDISTRIBUTIONONETIMEMARKETVALUEADJUSTMENTCHARGE","SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONMARKETVALUEADJUSTMENTCHARGE","RIDERCHARGE","FIXEDINTERESTCREDITAMOUNT","INDEXCREDITAMOUNT","INITIALPREMIUMPAYMENTCHARGE","SUBSEQUENTPREMIUMPAYMENTCHARGE","ONETIMEPREMIUMPAYMENTCHARGE","PREMIUMTAXAMOUNT","FULLSURRENDERAMOUNT","REQUIREDMINIMUMDISTRIBUTIONONETIMEAMOUNT","SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONAMOUNT","SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONSURRENDERCHARGE","CURRENTBASE","HYPOTHETICALANNUALLIMIT","RATCHETBASE","GROWTHBASE","DEFERRALBONUS","DEFERRALBONUSBASE","SIMPLEINTERESTBASE","REMAININGBENEFIT","NETDECREASEINFACEAMOUNT","NETINCREASEINFACEAMOUNT"]},"PolicyMetricsRequest":{"type":"object","properties":{"startDate":{"type":"string","description":"Start Date","example":"2024-02-02"},"endDate":{"type":"string","description":"End Date","example":"2024-02-02"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/MetricsType"}}}},"PolicyMetricsResponse":{"type":"object","properties":{"metric":{"type":"string","example":"LAPSEPROTECTIONPAYMENTAMOUNT","description":"Requested metric"},"begin":{"type":"number","format":"double","example":28.44,"description":"TBD"},"minimum":{"type":"number","format":"double","example":28.44,"description":"TBD"},"maximum":{"type":"number","format":"double","example":28.44,"description":"TBD"},"average":{"type":"number","format":"double","example":28.44,"description":"TBD"},"sum":{"type":"number","format":"double","example":8389.8,"description":"TBD"},"count":{"type":"integer","format":"int64","example":295,"description":"TBD"},"end":{"type":"number","format":"double","example":28.44,"description":"TBD"}}},"MetricsErrorResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2024-03-29T16:40:17.935761Z"},"message":{"type":"string","example":"Invalid date range provided"}}},"CancelTransactionRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067"},"transactionId":{"type":"string","example":"377"},"reason":{"type":"string","example":"Entered Incorrect Email Id","description":"Reason for cancellation"}},"required":["correlationId","transactionId","reason"]},"CorrectionSchema":{"type":"object","properties":{"transactionId":{"type":"string","example":"377"},"amount":{"type":"number","format":"double","description":"TBD","example":5}},"required":["transactionId","amount"]},"ReverseRecreateRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067"},"corrections":{"type":"array","items":{"$ref":"#/components/schemas/CorrectionSchema"}},"noRecreateTransactions":{"type":"boolean","description":"optional and default value is false","example":false}},"required":["correlationId","corrections"]},"ReinstatementApprovedFeatureType":{"type":"string","enum":["FREELOOK","LAPSEASSESSMENT","LAPSEPROTECTION","REINSTATEMENT"]},"ReinstatementApprovedAdhocPolicyFeature":{"type":"object","properties":{"featureType":{"$ref":"#/components/schemas/ReinstatementApprovedFeatureType"},"approvalDate":{"type":"string","example":"2024-02-21","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"}}},"ReinstatementApprovedAdhocPolicy":{"type":"object","properties":{"policyFeatures":{"type":"array","items":{"$ref":"#/components/schemas/ReinstatementApprovedAdhocPolicyFeature"}}}},"ReinstatementApproved":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","example":false,"default":false,"description":"Property to isolate source transaction(s) that initiated the reversal"},"policy":{"$ref":"#/components/schemas/ReinstatementApprovedAdhocPolicy"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"ReinstatementApprovedQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","description":"The unique ID to track transaction request across all systems","example":"657b717b7dcf554abf9ef067"},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"TransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","example":90,"format":"double","description":"Requested Amount to be adjusted"}}},"ValueAdjustment":{"type":"object","properties":{"fundId":{"type":"string","example":"EVGL001","description":"A unique identifier for the fund account involved in a value adjustment."},"segmentId":{"type":"string","example":"1","description":"A unique identifier for the specific segment affected by a value adjustment."},"coverageId":{"type":"string","description":"A unique identifier linking the value adjustment to a specific coverage component.","example":"Base_Coverage"}}},"ValueAdjustmentRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","example":false,"description":"Property to isolate source transaction(s) that initiated the reversal","default":false},"transactionReason":{"type":"string","enum":["CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","STARTINGPRICE","NATIONALCHANGEOFADDRESS"]},"transactionAmounts":{"$ref":"#/components/schemas/TransactionAmounts"},"valueAdjustment":{"$ref":"#/components/schemas/ValueAdjustment"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}}},"RequiredMinimumDistributionOneTimeRequestTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number"},"amountType":{"$ref":"#/components/schemas/AmountType"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"disbursementType":{"$ref":"#/components/schemas/DisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/DisbursementPaymentForm"},"accountNumber":{"type":"string","example":"123456789","description":"The unique identifier representing the policy number associated with a transaction for DTCC money movement."},"participantId":{"type":"string","example":"123456789","description":"The DTCC Participant ID (also known as a DTCC Number or Participant Number) is a unique identifier assigned by the Depository Trust & Clearing Corporation (DTCC) to financial institutions — such as broker-dealers, banks, or mutual funds — that participate in DTCC’s clearing and settlement systems."}}},"RequiredMinimumDistributionOneTimeRequest":{"type":"object","properties":{"correlationId":{"type":"string"},"effectiveDate":{"type":"string","format":"date"},"reverseInitiator":{"type":"boolean","default":false},"transactionAmounts":{"$ref":"#/components/schemas/RequiredMinimumDistributionOneTimeRequestTransactionAmounts"},"fundAllocation":{"$ref":"#/components/schemas/AdhocFundAllocation"},"taxWithholdingInstructions":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholdingInstructions"}},"parties":{"type":"array","items":{"$ref":"#/components/schemas/AdhocDisbursementParty"}},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"fundDistributions":{"type":"array","items":{"$ref":"#/components/schemas/AdhocFundDistributions"}},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"MultipleEmailChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}}}},"MultiplePhoneUpdateRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}}}},"IdentifiersRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"657b717b7dcf554abf9ef067","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2023-01-01","format":"date","description":"Date (with pattern \"yyyy-mm-dd\")"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}}}},"AnnuitizationFeature":{"type":"object","properties":{"frequency":{"$ref":"#/components/schemas/Frequency"},"firstPaymentDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"paymentForm":{"$ref":"#/components/schemas/PaymentForm"},"distributionCode":{"$ref":"#/components/schemas/DistributionCode"},"accountNumber":{"type":"string","example":"123456789","description":"The account number for the annuitization feature"},"participantId":{"type":"string","example":"123456789","description":"The participant ID for the annuitization feature"}}},"AdhocAnnuitization":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","description":"A boolean flag that applies only to financial transactions. \n When set to true, it allows a backdated transaction to be processed.  \nThis triggers a reversal on the policy to the earliest transaction on the specified effective date, \napplies the new transaction, and then reprocesses all subsequent transactions (similar to (R&R) process). \nThis ensures that the policy`s financial history remains accurate and aligned with the backdated change."},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"taxWithholdingInstructions":{"$ref":"#/components/schemas/TaxWithholdingInstructions"},"parties":{"$ref":"#/components/schemas/AdhocDisbursementParty"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"annuitizationFeature":{"$ref":"#/components/schemas/AnnuitizationFeature"},"suppression":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}}}},"AnnuitizationQuote":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\") when the transaction was originally scheduled or expected to happen, can be a non-business day"},"reverseInitiator":{"type":"boolean","example":false,"description":"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 policys financial history remains accurate and aligned with the backdated change."},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"taxWithholdingInstructions":{"$ref":"#/components/schemas/TaxWithholdingInstructions"},"parties":{"$ref":"#/components/schemas/AdhocDisbursementParty"},"annuitizationFeature":{"$ref":"#/components/schemas/AnnuitizationFeature"}}},"FaceAmountTransactionReason":{"type":"string","description":"Business reason for the face amount change (must match supported DAML mapping).","enum":["FACEDECREASECOVERAGE","FACEINCREASECOVERAGE"]},"FaceAmountChangeTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","example":250000,"format":"double","description":"Requested face amount for the covered contract or rider."}},"required":["requestedAmount"]},"CoverageType":{"type":"string","description":"Coverage indicator sent to the ledger as the Java `IndicatorCode` enum name (string form). Must be one of the supported indicator codes for the contract row being adjusted.","enum":["BASE","RIDER","BASEINCREASE","INTEGRATEDRIDER","RIDERINCREASE","BENEFIT","DISCOUNT","UNKNOWN","OTHER"]},"FaceAmountChangeValueAdjustment":{"type":"object","properties":{"coverageId":{"type":"string","example":"Base_Coverage","description":"Identifier of the coverage row being adjusted."},"coverageType":{"$ref":"#/components/schemas/CoverageType"}},"required":["coverageId","coverageType"]},"FaceAmountChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2026-04-10","format":"date","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day"},"reverseInitiator":{"type":"boolean","default":false,"description":"When true, allows a backdated financial transaction by reversing to the effective date, applying the change, and reprocessing subsequent transactions."},"transactionReason":{"$ref":"#/components/schemas/FaceAmountTransactionReason"},"transactionAmounts":{"$ref":"#/components/schemas/FaceAmountChangeTransactionAmounts"},"valueAdjustment":{"$ref":"#/components/schemas/FaceAmountChangeValueAdjustment"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}},"required":["correlationId","effectiveDate","transactionReason","transactionAmounts","valueAdjustment"]},"FaceAmountChangeQuoteResponse":{"type":"object","properties":{"correlationId":{"type":"string","description":"Quote payload returned for face amount change (correlation id and projected policy view)."},"policy":{"$ref":"#/components/schemas/BasePolicy"}}},"PolicyAttribute":{"type":"string","enum":["MODIFIEDENDOWMENTCONTRACTAUTHORIZATION"]},"PolicyAttributeAdjustment":{"type":"object","properties":{"policyAttribute":{"$ref":"#/components/schemas/PolicyAttribute"},"attributeValue":{"type":"string","description":"New value for the attribute (e.g. `\"true\"` / `\"false\"` for MEC authorization).","example":"true"}},"required":["policyAttribute","attributeValue"]},"PolicyDetailsChangeRequest":{"type":"object","properties":{"correlationId":{"type":"string","example":"864e43a0-2c2f-4a11-9d7f-69ed40115066","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","example":"2026-04-10","format":"date","description":"Date when the transaction was originally scheduled or expected to happen. It can be a non-business day"},"reverseInitiator":{"type":"boolean","default":false,"description":"When true, allows a backdated financial transaction by reversing to the effective date, applying the change, and reprocessing subsequent transactions."},"valueAdjustment":{"$ref":"#/components/schemas/PolicyAttributeAdjustment"},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"}},"required":["correlationId","effectiveDate","valueAdjustment"]},"AdhocReissuanceParty":{"type":"object","properties":{"partyType":{"$ref":"#/components/schemas/PartyType"},"partyRoleId":{"type":"string","description":"TBD"},"parentPartyId":{"type":"string","description":"The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)","example":"1"},"beneficiaryPercentage":{"type":"number","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary","example":100,"format":"double"},"agentPercentage":{"type":"number","format":"double","description":"Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent","example":100},"agentExternalId":{"type":"string","description":"The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent","example":"3160000751"},"agentType":{"$ref":"#/components/schemas/AgentType"},"firstName":{"type":"string","description":"The first name of the party/trustee","example":"Karen"},"middleName":{"type":"string","description":"The middle name of the party/trustee","example":"Anne"},"lastName":{"type":"string","description":"The last name of the party/trustee","example":"Bates"},"fullName":{"type":"string","description":"The full name of the party/The legal name of the Trust/Organization","example":"Karen Anne Bates"},"prefix":{"$ref":"#/components/schemas/Prefix"},"suffix":{"type":"string","enum":["JR","SN","SR","I","II","III","IV","V","VI","VII"],"description":"The suffix of the party name"},"gender":{"$ref":"#/components/schemas/Gender"},"dateOfBirth":{"type":"string","description":"The date of birth of the party","format":"date","example":"2023-01-01"},"genderIdentity":{"type":"string","description":"Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy","example":"TBD"},"attainedAge":{"type":"integer","description":"Age calculated by date of birth and Policy year","format":"int32","example":55},"birthCountry":{"$ref":"#/components/schemas/Country"},"citizenCountry":{"$ref":"#/components/schemas/Country"},"birthState":{"$ref":"#/components/schemas/State"},"doingBusinessAs":{"type":"string","description":"The name the organization is commonly known as","example":"TBD"},"abbreviatedName":{"type":"string","description":"The shortened/abbreviated version of the organization`s name that is unique to the organization","example":"TBD"},"organizationCode":{"type":"string","description":"Code to Identify organization","example":"TBD"},"entityType":{"$ref":"#/components/schemas/EntityType"},"trustDate":{"type":"string","description":"The trust agreement issued date to the party","format":"date","example":"2023-01-01"},"amendedTrustDate":{"type":"string","description":"The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy","format":"date","example":"2023-01-01"},"governingStateOfTrust":{"$ref":"#/components/schemas/State"},"trustType":{"$ref":"#/components/schemas/TrustType"},"trustTitle":{"type":"string","description":"The title of the trustee","example":"TBD"},"trustAccessCode":{"type":"string","description":"Access code of the trustee","example":"TBD"},"preferredCommunicationType":{"$ref":"#/components/schemas/PreferredCommunicationType"},"preferredAddressIndicator":{"type":"string","description":"Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section","example":"1"},"preferredAddressId":{"type":"string","description":"The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping","example":"1"},"preferredEmailId":{"type":"string","description":"The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file","example":"1"},"preferredPhoneId":{"type":"string","description":"The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party","example":"1"},"partyPercentage":{"type":"number","format":"double","description":"Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties","example":12.1213,"deprecated":true},"formerName":{"$ref":"#/components/schemas/FormerName"},"identifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"taxWithholdings":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"partyStatus":{"$ref":"#/components/schemas/PartyStatus"},"isPartyBeneficiaryNonNatural":{"type":"boolean","description":"A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities"},"isIrrevocable":{"type":"boolean","description":"An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms"},"isRequiredMinimumDistributionDesignated":{"type":"boolean","description":"An indicator if the beneficiary is designated to be included in Joint RMD calculations"},"lastContactDate":{"type":"string","format":"date","description":"Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.","example":"2023-01-01"},"beneficiaryShareMethod":{"type":"string","enum":["PERSTIRPESDISTRIBUTION"],"description":"The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request."},"delegatedExecutionAuthorityType":{"$ref":"#/components/schemas/DelegatedExecutionAuthorityType"},"partyRoles":{"type":"array","items":{"$ref":"#/components/schemas/PolicyPartyRoles"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressBase"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/PhoneBase"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailBase"}},"bankDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountBase"}},"startDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"endDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"beneficiaryAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}},"partyAllocation":{"type":"array","items":{"$ref":"#/components/schemas/PartyAllocation"}}}},"RiderElected":{"type":"string","enum":["ELECTED","NOTELECTED"]},"FlatExtraType":{"type":"string","enum":["TEMPORARY","PERMANENT"]},"AdhocReissuanceRiderFlatExtra":{"type":"object","properties":{"flatExtraType":{"$ref":"#/components/schemas/FlatExtraType"},"flatExtraDuration":{"type":"number","format":"int32","example":0,"description":"The Flat Extra Duration refers to the length of time a Flat Extra premium charge is applied to a life insurance policy. This duration depends on whether the Flat Extra is temporary or permanent, and it is determined by the insurer based on the risk factor associated with the insured."},"flatExtraAmount":{"type":"number","format":"double","example":0,"description":"The Flat Extra Amount refers to an additional charge per $1,000 of coverage that an insurer applies to a life insurance policy due to an increased risk factor. This extra cost is added on top of the standard premium and can be temporary or permanent, depending on the nature of the risk."},"flatExtraStartDate":{"type":"string","format":"date","example":"2023-01-01","description":"The Flat Extra Start Date refers to the date when an additional, fixed premium charge (Flat Extra) begins on a life insurance policy. This charge is typically applied due to an increased underwriting risk, such as hazardous occupations, high-risk hobbies, or medical conditions."}}},"AdhocReissuanceRiderRiderParticipants":{"type":"object","properties":{"partyId":{"type":"string","example":"Party_PI_1","description":"The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)"},"partyAgeAtIssue":{"type":"number","format":"int32","example":43,"description":"The Party Age at Issue refers to the age of any party associated with a life insurance or annuity policy at the time the contract is issued."},"riskClass":{"$ref":"#/components/schemas/RiskClass"},"substandardRating":{"$ref":"#/components/schemas/SubStandardRating"},"flatExtra":{"type":"array","items":{"$ref":"#/components/schemas/AdhocReissuanceRiderFlatExtra"}}}},"AdhocReissuanceRiderRiderCoverageLayer":{"type":"object","properties":{"coverageId":{"type":"string","example":"Base_Coverage","description":"The Coverage ID is a unique identifier assigned to a specific coverage type or benefit within an insurance policy. It helps insurance companies, agents, and policyholders track and differentiate multiple coverage components within a single policy."},"coverageType":{"$ref":"#/components/schemas/RiderType"},"coverageName":{"type":"string","example":"Base_Coverage","description":"The Coverage Name in a life insurance policy refers to the specific title or label assigned to a coverage type within the policy contract. It helps insurers, agents, and policyholders identify, classify, and manage different coverage components in a policy."},"approvedCoverageAmount":{"type":"number","format":"double","example":10000,"description":"The Approved Coverage Amount refers to the specific amount of insurance coverage that has been approved by the insurer during the underwriting process. It represents the face amount (death benefit) the insurer has agreed to issue based on the applicant's risk profile, health, and other underwriting criteria."},"currentAmount":{"type":"number","format":"double","example":300000,"description":"The Current Coverage Amount refers to the active or present death benefit or coverage value available under the policy at a specific point in time. It reflects any adjustments, policy changes, withdrawals, or loans that may have altered the original coverage amount."},"originalCoverageAmount":{"type":"number","format":"double","example":300000,"description":"The Original Coverage Amount refers to the initial face value or death benefit of a policy at the time of issuance before any policy modifications, withdrawals, loans, or benefit reductions. It represents the starting coverage amount agreed upon when the policy was first issued."},"lowDeathBenefitAmount":{"type":"number","format":"double","example":300000,"description":"Low Death Benefit refers to the lowest possible death benefit guaranteed within each specific coverage component of a policy. This ensures that beneficiaries receive at least a minimum death benefit regardless of market performance, policy changes, or withdrawals."},"coverageEffectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"The Coverage Effective Date refers to the date when an increase in coverage or a new coverage component officially takes effect in a life insurance policy. It marks the beginning of the insured’s eligibility for the new or increased benefits."},"coverageChangeEffectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"The Coverage Change Effective Date (for a decrease in coverage) refers to the date when the reduced coverage amount officially takes effect in a life insurance policy. It marks the point from which the new lower coverage amount applies."},"coverageTerm":{"type":"number","format":"int32","example":1,"description":"Coverage Term refers to the number of years that a life insurance policy or specific coverage component is intended to remain in force, providing protection to the insured. It defines the planned duration of insurance coverage, after which the coverage may expire, renew, or convert, depending on the product type."}}},"AdhocReissuanceRider":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/RiderType"},"riderName":{"type":"string","example":"The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit","description":"Rider name"},"riderElected":{"$ref":"#/components/schemas/RiderElected"},"riderCode":{"type":"string","example":"SBLCHR","description":"A unique identifier or alphanumeric code assigned to the rider"},"payoutOption":{"type":"string","enum":["SINGLE","JOINT"],"description":"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."},"status":{"$ref":"#/components/schemas/Status"},"coverageId":{"type":"string","example":"Rider_SBLCHR","description":"An unique identifier assigned to the rider coverage within an insurance coverage or policy layer."},"amount":{"type":"number","format":"double","example":0,"description":"The total benefit amount the rider provides (separate from the base policy’s coverage.)"},"riderParticipants":{"description":"Note - Use riderParticipants field instead of riderParticipant","type":"array","items":{"$ref":"#/components/schemas/AdhocReissuanceRiderRiderParticipants"}},"coverageLayers":{"type":"array","items":{"$ref":"#/components/schemas/AdhocReissuanceRiderRiderCoverageLayer"}},"underwritingStatus":{"$ref":"#/components/schemas/UnderwritingStatus"},"unbornChildIndicator":{"type":"boolean","example":true,"description":"When true, indicates there is no named child rider insured and the rider is being used to cover an unborn child."}}},"AdhocReissuancePolicyFeature":{"type":"object","properties":{"featureType":{"$ref":"#/components/schemas/FeatureType"},"featureIndicator":{"type":"boolean","example":true,"description":"A Feature Indicator in life insurance and annuities refers to a binary flag (Yes/No, True/False, or Enabled/Disabled) that signifies whether a specific policy feature, rider, or benefit is included in the contract. It helps insurers, agents, and policyholders quickly identify which optional or standard benefits apply to a policy"},"startDate":{"type":"string","format":"date","description":"The date when the loan segment becomes active and enforceable within the policy.","example":"2023-01-01"},"endDate":{"type":"string","format":"date","description":"The date when the loan segment is fully repaid, closed, or no longer applicable.","example":"2023-01-01"},"period":{"type":"number","format":"int32","description":"The Period of Feature in life insurance and annuities refers to the duration for which a specific feature or benefit is available, active, or applicable within a policy or contract. It defines the time frame in which a feature can be used, exercised, or remains valid","example":30}}},"AdhocReissuancePolicyDates":{"type":"object","properties":{"issueDate":{"type":"string","format":"date","description":"The date the policy was issued (with pattern \"yyyy-mm-dd\").","example":"2023-01-01"}},"required":["issueDate"]},"AdhocReissuanceFundAllocationsInvestments":{"type":"object","properties":{"fundId":{"type":"string","description":"A unique identifier assigned to a specific fund account within the investment structure.","example":"ELI002"},"fundName":{"type":"string","description":"The official business name of the specific fund account within the investment structure.","example":"Fund"},"fundAccountType":{"$ref":"#/components/schemas/AccountType"},"allocationPercentage":{"type":"number","format":"double","description":"The percentage of total fund allocation assigned to a particular fund account.","example":100},"startDate":{"type":"string","format":"date","example":"2023-01-01","description":"The date when the loan segment becomes active and enforceable within the policy."}}},"AdhocReissuanceFundAllocation":{"type":"object","properties":{"investmentType":{"$ref":"#/components/schemas/InvestmentType"},"fundAllocationsInvestments":{"type":"array","items":{"$ref":"#/components/schemas/AdhocReissuanceFundAllocationsInvestments"}}}},"AdhocReissuance":{"type":"object","properties":{"correlationId":{"type":"string","example":"5df63b47-54fc-4905-a8ff-e1c5f12e667d","description":"The unique ID to track transaction request across all systems"},"effectiveDate":{"type":"string","format":"date","example":"2023-01-01","description":"Date (with pattern \"yyyy-mm-dd\")"},"reverseInitiator":{"type":"boolean","default":false,"description":"When set to true, allows a backdated transaction to be processed."},"externalIdentifiers":{"$ref":"#/components/schemas/AdhocExternalIdentifiers"},"party":{"$ref":"#/components/schemas/AdhocReissuanceParty"},"riders":{"type":"array","items":{"$ref":"#/components/schemas/AdhocReissuanceRider"}},"policyFeatures":{"type":"array","items":{"$ref":"#/components/schemas/AdhocReissuancePolicyFeature"}},"policyDates":{"$ref":"#/components/schemas/AdhocReissuancePolicyDates"},"allocation":{"$ref":"#/components/schemas/AdhocReissuanceFundAllocation"}},"required":["correlationId","effectiveDate"]},"IriProductType":{"type":"string","description":"Product type.","enum":["FIXED","VARIABLE","INDEXED","IMMEDIATE","DEFERRED"]},"IriProduct":{"type":"object","properties":{"planName":{"type":"string","description":"Marketing/plan name of the product.","example":"Fixed Indexed Annuity Premier","maxLength":200},"productType":{"$ref":"#/components/schemas/IriProductType"},"shortName":{"type":"string","description":"Short display name of the product.","example":"FIA Premier","maxLength":100},"planCode":{"type":"string","description":"Carrier-assigned plan code.","example":"FIAPRM01","pattern":"^[A-Za-z0-9]{1,50}$"}},"required":["planName","productType","planCode"]},"IriQualificationType":{"type":"string","description":"Tax qualification type.","enum":["Non-Qualified","Solo 401k","401k","403b","457 Deferred Compensation","Inherited IRA","IRA Spousal","Educational IRA","IRA","IRA Rollover","IRA Transfer","Roth IRA","Roth IRA - Inherited","SEP IRA","SIMPLE IRA","Pension Plan","Cash Balance Plan-Defined Contributions","Solo Defined Benefit","Cash Balance Plan-Defined Benefit","Profit Sharing Plan","Money Purchase Plan","SAREP","401g","HR10","Welfare Benefit Plan","Roth 401K","Roth 403b","Roth 457"]},"IriPolicyStatus":{"type":"string","description":"Policy status.","enum":["PENDINGISSUED","ACTIVE","LAPSED","SURRENDERED","TERMINATED"]},"IriRestrictionCategory":{"type":"string","description":"Restriction category. Enum values use underscore-delimited tokens.","enum":["PRODUCT_RULE","CONTRACT","AUTHORIZATION_IDENTITY","TRANSACTION","ARRANGEMENT","PARTY_CONTRACT_DATA"]},"IriRestrictionSubCategory":{"type":"string","description":"Restriction sub-category.","enum":["TRANSFER_NOT_ELIGIBLE","STATUS_OR_GLOBAL_RESTRICTION","RESTRICTED_TRADES_FLAG","AGENT_NOT_AUTHORIZED","SHORT_TERM_TRADING_LIMIT","ANNUAL_TRANSFER_LIMIT_EXCEEDED","ENROLLMENT_CONFLICT","CONFLICTING_TRANSACTION_PENDING","COLLATERAL_ASSIGNMENT","RECENT_OWNER_CHANGE","RECENT_ADDRESS_CHANGE","LOAN_OUTSTANDING","CONFLICTING_RIDER","CONFLICTING_ARRANGEMENT","PRODUCT_RULES","EXCESSIVE_TRADING_RESTRICTION","NO_SIGNATURE_ON_FILE","INVALID_GOVT_ID","WITHDRAWAL_FULL_LIQUIDATION","WITHDRAWAL_SPECIFIED_AMOUNT","WITHDRAWAL_SPECIFIED_PERCENTAGE","WITHDRAWAL_INTEREST_ONLY","WITHDRAWAL_RMD","WITHDRAWAL_RIDER_FREE_AMOUNT","WITHDRAWAL_SURRENDER_FREE_AMOUNT","WITHDRAWAL_FUND_SPECIFIC","WITHDRAWAL_PRORATA","WITHDRAWAL_PRORATA_VARIABLE_FUNDS","WITHDRAWAL_SYSTEMATIC","DCA_RESTRICTION","SWEEP_RESTRICTION","REBALANCE_RESTRICTION","INVEST_RESTRICTION","PRORATA_INVEST_RESTRICTION","PRORATA_VARIABLE_FUNDS_INVEST_RESTRICTION","FUND_SPECIFIC_INVEST_RESTRICTION","WITHDRAWAL_RMD_CARRIER_CALC"]},"IriRestrictionReason":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/IriRestrictionCategory"},"subCategory":{"$ref":"#/components/schemas/IriRestrictionSubCategory"},"reason":{"type":"string","description":"Human-readable reason for the restriction.","example":"Collateral Assignment","minLength":1,"maxLength":200},"definition":{"type":"string","description":"Definition/detail of the restriction.","example":"Collateral assignment on the contract","minLength":1,"maxLength":500}},"required":["category","subCategory","reason","definition"]},"IriIssueType":{"type":"string","description":"Underwriting/issue type.","enum":["FULLUNDERWRITING","SIMPLIFIED","GUARANTEED"]},"IriPolicySummary":{"type":"object","properties":{"effectiveDate":{"type":"string","description":"Policy effective date (yyyy-mm-dd).","example":"2021-01-15","format":"date"},"cusip":{"type":"string","description":"CUSIP identifier for the product.","example":"78462F103","minLength":9,"maxLength":9,"pattern":"^[0-9]{3}[A-Z0-9]{5}[0-9]$"},"carrierId":{"type":"string","description":"Carrier identifier.","example":"CARR123","maxLength":10},"carrierName":{"type":"string","description":"Carrier display name.","example":"Contoso Life & Annuity","maxLength":200},"policyLastRefreshDateTime":{"type":"string","description":"Timestamp the policy data was last refreshed.","example":"2026-03-06T16:30:00Z","format":"date-time"},"product":{"$ref":"#/components/schemas/IriProduct"},"qualificationType":{"$ref":"#/components/schemas/IriQualificationType"},"policyStatus":{"$ref":"#/components/schemas/IriPolicyStatus"},"hasRestriction":{"type":"boolean","description":"Whether the policy has one or more active restrictions.","example":true},"restrictions":{"description":"Active restrictions. Required when `hasRestriction` is true.","type":"array","items":{"$ref":"#/components/schemas/IriRestrictionReason"}},"issueType":{"$ref":"#/components/schemas/IriIssueType"},"issueState":{"type":"string","description":"Two-letter issue state code.","example":"NC","pattern":"^[A-Z]{2}$"},"currency":{"type":"string","description":"ISO 4217 three-letter currency code.","example":"USD","pattern":"^[A-Z]{3}$"}},"required":["effectiveDate","carrierId","policyLastRefreshDateTime","product","policyStatus","issueType","currency"]},"IriValidationError":{"type":"object","properties":{"code":{"type":"string","description":"Structured error code classifying the business rule or decision failure.","pattern":"^[a-zA-Z]+\\.[a-zA-Z]+\\.[a-zA-Z]+$","example":"policy.inquiry.notFound"},"message":{"type":"string","description":"Why the error occurred / specific business rule violation."}},"required":["code","message"]},"IriError":{"type":"object","properties":{"code":{"type":"string","description":"A structured error code <domain>.<category>.<subcategory>.","pattern":"^[a-zA-Z]+\\.[a-zA-Z]+\\.[a-zA-Z]+$","example":"policy.inquiry.notFound"},"timestamp":{"type":"string","description":"Timestamp the error occurred.","format":"date-time"},"message":{"type":"string","description":"Message with specific error details."},"validationErrors":{"description":"Logical rule violations related to business logic or rules.","type":"array","items":{"$ref":"#/components/schemas/IriValidationError"}}},"required":["code","message"]},"IriAccountDesignation":{"type":"string","description":"Account designation / role type.","enum":["INDIVIDUAL","JOINT","TRUST","CUSTODIAL","OTHER"]},"IriPayoutType":{"type":"string","description":"Payout / product type.","enum":["DEFERRED","IMMEDIATE","ANNUITIZED","ACCUMULATION","UNKNOWN"]},"IriAccountValues":{"type":"object","properties":{"beginningAccountValue":{"type":"number","description":"Total cash value of the policy/annuity at the beginning of each transaction (loaned + unloaned).","example":161.82,"minimum":0,"maximum":9999999999.99},"endingAccountValue":{"type":"number","description":"Total cash value of the policy/annuity (loaned + unloaned) as of the last processed transaction.","example":161.82,"minimum":0,"maximum":9999999999.99},"minimumRequiredAccountValue":{"type":"number","description":"Lowest account value that must be maintained to keep the contract active. May be 0 for some products.","example":0,"minimum":0,"maximum":9999999999.99},"unloanedPortionOfAccountValue":{"type":"number","description":"Portion of the total account value that is not affected by policy loans.","example":161.82,"minimum":0,"maximum":9999999999.99},"loanedPortionOfAccountValue":{"type":"number","description":"Amount of the account value used as collateral for a policy loan.","example":0,"minimum":0,"maximum":9999999999.99},"surrenderValue":{"type":"number","description":"Amount paid to the policyholder upon voluntary surrender, after charges, loans, and fees.","example":161.82,"minimum":0,"maximum":9999999999.99},"surrenderValueWithoutMarketValueAdjustment":{"type":"number","description":"Surrender value without market value adjustment included.","example":161.82,"minimum":0,"maximum":9999999999.99},"guaranteedCashSurrenderValueFixed":{"type":"number","description":"Minimum cash value guaranteed on surrender regardless of market conditions (fixed).","example":161.82,"minimum":0,"maximum":9999999999.99},"guaranteedCashSurrenderValueIndexed":{"type":"number","description":"Indexed amount guaranteed on surrender. Only required for Annuity FIA products.","example":161.82,"minimum":0,"maximum":9999999999.99},"interestEarned":{"type":"number","description":"Interest credited to the policy/annuity based on the accumulated account value.","example":12.34,"minimum":0,"maximum":9999999999.99},"totalNetWithdrawalSinceIssue":{"type":"number","description":"Running total of all net withdrawals since policy issuance.","example":0,"minimum":0,"maximum":9999999999.99},"totalGainWithdrawnSinceIssue":{"type":"number","description":"Total of all earnings withdrawn since policy issue.","example":0,"minimum":0,"maximum":9999999999.99}},"required":["endingAccountValue"]},"IriLoanValues":{"type":"object","properties":{"totalLoanBalance":{"type":"number","description":"Outstanding loan amount including principal, accrued interest, and unpaid loan charges.","example":0,"minimum":0,"maximum":9999999999.99},"totalLoanPrincipal":{"type":"number","description":"Original amount borrowed against the cash value, excluding accrued interest or charges.","example":0,"minimum":0,"maximum":9999999999.99},"loanPayoffAmount":{"type":"number","description":"Total amount required to fully repay the policy loan, including accrued interest and adjustments.","example":0,"minimum":0,"maximum":9999999999.99},"maximumLoanAmount":{"type":"number","description":"Highest amount that can be borrowed against the cash value.","example":0,"minimum":0,"maximum":9999999999.99},"minimumLoanAmount":{"type":"number","description":"Smallest amount that can be borrowed against the cash value.","example":0,"minimum":0,"maximum":9999999999.99},"totalLoanAccruedInterest":{"type":"number","description":"Interest accrued on the policy loan within the current year.","example":0,"minimum":0,"maximum":9999999999.99},"lastLoanInterestDueDate":{"type":"string","description":"Last policy anniversary date when loan interest was due on an outstanding loan (yyyy-mm-dd).","example":"2023-01-01","format":"date"},"totalNumberOfLoan":{"type":"number","description":"Total count of policy loans taken over the life of the policy.","example":0,"minimum":0},"totalYearToDateLoanTaken":{"type":"number","description":"Total amount of policy loans taken within the current calendar or policy year.","example":0,"minimum":0,"maximum":9999999999.99}}},"IriWithdrawalValues":{"type":"object","properties":{"totalWithdrawalAmount":{"type":"number","description":"Cumulative amount of funds withdrawn since policy inception.","example":0,"minimum":0,"maximum":9999999999.99},"freeWithdrawalAmount":{"type":"number","description":"Maximum amount that can be withdrawn in a contract year without a surrender charge.","example":10000,"minimum":0,"maximum":9999999999.99},"yearToDateFreeWithdrawalAmount":{"type":"number","description":"Amount withdrawn so far in the current contract year within the free withdrawal limit.","example":0,"minimum":0,"maximum":9999999999.99},"minimumWithdrawalAmount":{"type":"number","description":"Smallest amount that can be withdrawn in a single transaction.","example":0,"minimum":0,"maximum":9999999999.99},"maximumWithdrawalAmount":{"type":"number","description":"Highest amount that can be withdrawn in a single transaction or policy year.","example":0,"minimum":0,"maximum":9999999999.99},"freeAvailableAmount":{"type":"number","description":"Remaining free withdrawal amount available.","example":0,"minimum":0,"maximum":9999999999.99}},"required":["yearToDateFreeWithdrawalAmount"]},"IriMarketValueAdjustment":{"type":"object","properties":{"isMarketValueAdjusted":{"type":"boolean","description":"Whether a market value adjustment applies to the policy.","example":false}}},"IriRmdInfo":{"type":"object","properties":{"rmdTaxYear":{"type":"number","description":"Tax year the required minimum distribution applies to.","example":2026,"minimum":1900,"maximum":2100},"totalRMDAmountRemaining":{"type":"number","description":"Total required minimum distribution amount remaining.","example":0,"minimum":0,"maximum":9999999999.99}}},"IriBusinessMethod":{"type":"string","description":"Business methods available for authorization.","enum":["mail","electronic","fax","phone","voiceResponseUnit","internet"]},"IriAuthorizationEntity":{"type":"object","properties":{"authorizationEntity":{"type":"string","description":"Name of the authorized entity.","example":"Contoso Advisors","maxLength":100},"isAllAgentsAuthorized":{"type":"boolean","description":"Whether all agents are authorized for the entity.","example":true}}},"IriAdministrativeTransaction":{"type":"string","description":"Administrative transactions the caller is authorized for.","enum":["fundTransfer","withdrawal","arrangementAdministration","allTransactions"]},"IriAuthorizationTransaction":{"type":"object","properties":{"administrativeTransactions":{"type":"array","items":{"$ref":"#/components/schemas/IriAdministrativeTransaction"}},"isAuthorizationSignatureRequired":{"type":"boolean","description":"Whether an authorization signature is required.","example":false}},"required":["administrativeTransactions"]},"IriAuthorization":{"type":"object","properties":{"businessMethods":{"type":"array","items":{"$ref":"#/components/schemas/IriBusinessMethod"}},"authorizationEntities":{"type":"array","items":{"$ref":"#/components/schemas/IriAuthorizationEntity"}},"authorizationTransaction":{"$ref":"#/components/schemas/IriAuthorizationTransaction"}},"required":["businessMethods","authorizationEntities","authorizationTransaction"]},"IriPolicyValue":{"type":"object","properties":{"valuesAsOfDate":{"type":"string","description":"Date the values are reported as of (yyyy-mm-dd).","example":"2026-03-31","format":"date"},"accountDesignation":{"$ref":"#/components/schemas/IriAccountDesignation"},"jurisdiction":{"type":"string","description":"Two-letter jurisdiction code.","example":"NC","pattern":"^[A-Z]{2}$"},"sponsoringPlanSeparationDate":{"type":"string","description":"Sponsoring plan separation date (yyyy-mm-dd).","example":"2026-01-01","format":"date"},"payoutType":{"$ref":"#/components/schemas/IriPayoutType"},"totalDepositITD":{"type":"number","description":"Total deposit inception-to-date.","example":0,"minimum":0,"maximum":9999999999.99},"surrenderChargeFreeDate":{"type":"string","description":"Date surrender charges no longer apply (yyyy-mm-dd).","example":"2031-01-01","format":"date"},"digitalPaymentTypeCode":{"type":"string","description":"Digital payment type code.","example":"ACH","pattern":"^[A-Za-z0-9._-]{1,100}$"},"digitalPaymentTypeDescription":{"type":"string","description":"Digital payment type description.","example":"Automated Clearing House","maxLength":100},"accountValues":{"$ref":"#/components/schemas/IriAccountValues"},"loanValues":{"$ref":"#/components/schemas/IriLoanValues"},"withdrawalValues":{"$ref":"#/components/schemas/IriWithdrawalValues"},"marketValueAdjustment":{"$ref":"#/components/schemas/IriMarketValueAdjustment"},"rmdInfo":{"$ref":"#/components/schemas/IriRmdInfo"},"authorization":{"$ref":"#/components/schemas/IriAuthorization"}},"required":["valuesAsOfDate","accountValues"]},"IriPartyType":{"type":"string","description":"Type of party.","enum":["individual","entity"]},"IriPartyRelationship":{"type":"string","description":"Relationships the party has to the policy.","enum":["owner","jointOwner","annuitant","jointAnnuitant","primaryBeneficiary","contingentBeneficiary"]},"IriPartyPaymentForm":{"type":"string","description":"Party-level payment form. Bank details are required by the IRI schema for ACH, WIRE, and DTCC.","enum":["DTCC","ACH","CHECK","WIRE","EXCHANGE"]},"IriBankAccountStatus":{"type":"string","description":"Status of the bank account.","enum":["ACTIVEBANKACCOUNT","TERMINATEDBANKACCOUNT"]},"IriBankAccountType":{"type":"string","description":"Type of the bank account.","enum":["CHECKING","SAVINGS","CREDITCARDACCOUNT","DEBITCARDACCOUNT","BROKERAGEACCOUNT","CERTIFICATEOFDEPOSITACCOUNT"]},"IriPartyBank":{"type":"object","properties":{"bankId":{"type":"string","description":"Bank identifier.","example":"BNK123","maxLength":100},"nameOnAccount":{"type":"string","description":"Name on the bank account.","example":"JOHN Q PUBLIC","maxLength":100},"accountStatus":{"$ref":"#/components/schemas/IriBankAccountStatus"},"accountType":{"$ref":"#/components/schemas/IriBankAccountType"},"accountNumber":{"type":"string","description":"Bank account number.","example":"0000123412341234","maxLength":17,"pattern":"^\\d{4,17}$"},"routingNumber":{"type":"string","description":"Routing number.","example":"021000021","pattern":"^\\d{9}$"},"branchName":{"type":"string","description":"Branch name.","example":"Charlotte Main Branch","maxLength":100}},"required":["nameOnAccount","accountType","accountNumber","routingNumber"]},"IriAddressType":{"type":"string","description":"Type of address.","enum":["RESIDENCE","BUSINESS","POBOXSEASONAL","OTHER"]},"IriPartyAddress":{"type":"object","properties":{"addressId":{"type":"string","description":"Address identifier.","example":"ADDR001","maxLength":100},"addressType":{"$ref":"#/components/schemas/IriAddressType"},"addressLine1":{"type":"string","description":"First line of the address.","example":"123 Elm St","maxLength":100},"addressLine2":{"type":"string","description":"Second line of the address.","example":"Unit 5","maxLength":100},"addressLine3":{"type":"string","description":"Third line of the address.","example":"Building B","maxLength":100},"addressLine4":{"type":"string","description":"Fourth line of the address.","example":"Floor 3","maxLength":100},"addressLine5":{"type":"string","description":"Fifth line of the address.","example":"Attn: Accounts","maxLength":100},"city":{"type":"string","description":"City name.","example":"Charlotte","maxLength":100},"state":{"type":"string","description":"State code.","example":"NC","pattern":"^[A-Z]{2}$"},"zipCode":{"type":"string","description":"Zip code.","example":"28202","pattern":"^[0-9A-Za-z -]{3,10}$"},"zipCodeExtension":{"type":"string","description":"Zip code extension.","example":"1234","pattern":"^[0-9A-Za-z]{1,4}$"},"country":{"type":"string","description":"Country code.","example":"US","pattern":"^[A-Z]{2}$"}},"required":["addressType","addressLine1","city","state","zipCode"]},"IriPhoneType":{"type":"string","description":"Classification of the phone number.","enum":["MOBILE","HOME","BUSINESS","CLAIMCENTER","CUSTOMERSERVICE","CORPORATEOFFICE","FAX","UNKNOWN","OTHER"]},"IriPhoneBestTime":{"type":"string","description":"Best time to contact the party via phone.","enum":["MORNING","AFTERNOON","EVENING","ANYTIME"]},"IriPartyPhone":{"type":"object","properties":{"startDate":{"type":"string","description":"Date the phone record becomes effective.","example":"2026-03-06","format":"date"},"endDate":{"type":"string","description":"Date the phone record ends.","example":"2027-03-06","format":"date"},"phoneType":{"$ref":"#/components/schemas/IriPhoneType"},"countryCode":{"type":"string","description":"Country code of the phone.","example":"+1","pattern":"^\\+?[0-9]{1,3}$"},"areaCode":{"type":"string","description":"Area code of the phone.","example":"704","pattern":"^[0-9]{2,5}$"},"dialNumber":{"type":"string","description":"Dial number of the phone.","example":"5550123","pattern":"^[0-9]{4,12}$"},"extension":{"type":"string","description":"Dial-in extension for the phone.","example":"123","pattern":"^[A-Za-z0-9-]{1,10}$"},"bestTime":{"$ref":"#/components/schemas/IriPhoneBestTime"},"timezone":{"type":"string","description":"Timezone for the entered phone details.","example":"America/New_York","pattern":"^[A-Za-z_]+/[A-Za-z_]+(?:/[A-Za-z_]+)?$"},"isPreferred":{"type":"boolean","description":"Whether this is the preferred phone number.","example":true},"phoneId":{"type":"string","description":"Record identifier for the phone.","example":"PH001","pattern":"^[A-Za-z0-9._-]{1,100}$"}},"required":["countryCode","areaCode","dialNumber"]},"IriEmailType":{"type":"string","description":"Type or category of the email address.","enum":["PERSONAL","BUSINESS","CUSTOMERSERVICE","OTHER"]},"IriPartyEmail":{"type":"object","properties":{"startDate":{"type":"string","description":"Date the email record becomes effective.","example":"2026-03-06","format":"date"},"endDate":{"type":"string","description":"Date the email record ends.","example":"2027-03-06","format":"date"},"emailType":{"$ref":"#/components/schemas/IriEmailType"},"emailAddress":{"type":"string","description":"Email address of the party.","example":"john.public@example.com","format":"email","pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"},"isPreferred":{"type":"boolean","description":"Whether this is the preferred email address.","example":true},"emailId":{"type":"string","description":"Record identifier for the email.","example":"EM001","pattern":"^[A-Za-z0-9._-]{1,100}$"}},"required":["emailAddress"]},"IriIdentificationType":{"type":"string","description":"Type of identification.","enum":["PASSPORT","STATEPHOTOID","DRIVERLICENSENUMBER","SSN","TIN","EXTERNAL","EIN","OTHER"]},"IriPartyIdentification":{"type":"object","properties":{"identificationId":{"type":"string","description":"Identifier for the identification record.","example":"IDE-875","pattern":"^[A-Za-z0-9._-]{1,100}$"},"startDate":{"type":"string","description":"Date the identification record becomes effective.","example":"2026-03-06","format":"date"},"endDate":{"type":"string","description":"Date the identification record ends.","example":"2028-03-06","format":"date"},"identificationType":{"$ref":"#/components/schemas/IriIdentificationType"},"identificationKey":{"type":"string","description":"Identification key.","example":"US-PPT","pattern":"^[A-Za-z0-9._-]{1,100}$"},"identificationValue":{"type":"string","description":"Identification value.","example":"999888777","maxLength":100},"identificationDescription":{"type":"string","description":"Description of the identifier.","example":"US Passport","maxLength":255},"issueState":{"type":"string","description":"State that issued the identification.","example":"NC","pattern":"^[A-Z]{2}$"},"issueCountry":{"type":"string","description":"Country that issued the identification.","example":"US","pattern":"^[A-Z]{2}$"}},"required":["startDate","endDate"]},"IriPartyTaxWithholdingParty":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IriPartyType"},"firstName":{"type":"string","description":"First name of the individual party.","example":"John","minLength":1,"maxLength":100},"middleName":{"type":"string","description":"Middle name of the individual party.","example":"Q","minLength":1,"maxLength":100},"lastName":{"type":"string","description":"Last name of the individual party.","example":"Public","minLength":1,"maxLength":100},"name":{"type":"string","description":"Entity name of the party.","example":"Public Family Trust","minLength":1,"maxLength":100},"taxId":{"type":"string","description":"Tax identification number for the party.","example":"123456789","minLength":9,"maxLength":9,"pattern":"^[0-9]{9}$"}},"required":["type","taxId"]},"IriTaxWithholdingType":{"type":"string","description":"Type of tax withholding.","enum":["FEDERAL","STATE","NRA","BACKUP"]},"IriTaxRateToUse":{"type":"string","description":"Selected tax rate source.","enum":["NOWITHHOLDINGELECTED","USEVALUESENTERED","NOWITHHOLDINGALLOWED","USEDEFAULTTABLE"]},"IriFilingStatus":{"type":"string","description":"Tax filing status. Usually populated when default withholding tables are used.","enum":["SINGLE","DOMESTICPARTNERSHIP","DEFAULT","MARRIED","HEADOFHOUSEHOLD","WIDOWED","DIVORCED"]},"IriPartyTaxWithholdingInstruction":{"type":"object","properties":{"party":{"description":"Impacted party details for withholding.","allOf":[{"$ref":"#/components/schemas/IriPartyTaxWithholdingParty"}]},"taxWithholdingType":{"$ref":"#/components/schemas/IriTaxWithholdingType"},"taxRateToUse":{"$ref":"#/components/schemas/IriTaxRateToUse"},"filingStatus":{"$ref":"#/components/schemas/IriFilingStatus"},"dollar":{"type":"number","description":"Fixed dollar amount to withhold. Mutually exclusive with percentage.","example":125,"minimum":0,"maximum":9999999999.99},"percentage":{"type":"number","description":"Percentage rate to withhold. Mutually exclusive with dollar.","example":10,"minimum":0,"maximum":100},"exemptions":{"type":"number","description":"Requested exemptions value.","example":0,"minimum":0,"maximum":99},"taxJurisdiction":{"type":"string","description":"Jurisdiction for tax purposes. Required by the IRI schema when taxWithholdingType is STATE.","example":"NC","maxLength":50}},"required":["taxWithholdingType","taxRateToUse"]},"IriPartyDeathDetails":{"type":"object","properties":{"dateOfDeath":{"type":"string","description":"Date on which the insured or annuitant died.","example":"2026-03-06","format":"date"},"causeOfDeath":{"type":"string","description":"Documented reason or medical determination for death.","example":"Natural causes","maxLength":100},"deathNotificationDate":{"type":"string","description":"Date on which the carrier was notified of the death.","example":"2026-03-07","format":"date"},"dateOfDueProof":{"type":"string","description":"Date the appropriate death paperwork was received.","example":"2026-03-10","format":"date"}}},"IriPolicyParty":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IriPartyType"},"firstName":{"type":"string","description":"First name of the individual party.","example":"John","minLength":1,"maxLength":100},"middleName":{"type":"string","description":"Middle name of the individual party.","example":"Q","minLength":1,"maxLength":100},"lastName":{"type":"string","description":"Last name of the individual party.","example":"Public","minLength":1,"maxLength":100},"name":{"type":"string","description":"Entity name of the party.","example":"Public Family Trust","minLength":1,"maxLength":100},"taxId":{"type":"string","description":"Tax identification number for the party.","example":"123456789","minLength":9,"maxLength":9,"pattern":"^[0-9]{9}$"},"relationships":{"type":"array","minItems":1,"maxItems":6,"items":{"$ref":"#/components/schemas/IriPartyRelationship"}},"paymentForm":{"$ref":"#/components/schemas/IriPartyPaymentForm"},"allocationPercentage":{"type":"number","description":"Percentage share assigned to the party.","example":100,"minimum":0,"maximum":100},"bank":{"description":"Financial institution details.","allOf":[{"$ref":"#/components/schemas/IriPartyBank"}]},"address":{"description":"Physical or mailing address details.","allOf":[{"$ref":"#/components/schemas/IriPartyAddress"}]},"phones":{"description":"Phone numbers associated with the party.","type":"array","items":{"$ref":"#/components/schemas/IriPartyPhone"}},"emails":{"description":"Email addresses associated with the party.","type":"array","items":{"$ref":"#/components/schemas/IriPartyEmail"}},"identifications":{"description":"Identifications associated with the party.","type":"array","items":{"$ref":"#/components/schemas/IriPartyIdentification"}},"taxWithholdingInstructions":{"description":"Tax withholding instructions associated with the party.","type":"array","items":{"$ref":"#/components/schemas/IriPartyTaxWithholdingInstruction"}},"deathDetails":{"description":"Death details associated with the party.","allOf":[{"$ref":"#/components/schemas/IriPartyDeathDetails"}]}},"required":["type","taxId","relationships"]},"IriPolicyParties":{"type":"object","properties":{"startIndex":{"type":"number","description":"Used for pagination to indicate where the returned page starts within the full result set.","example":0,"minimum":0},"itemsCount":{"type":"number","description":"Number of records included in the current response page.","example":1,"minimum":0},"totalItemsCount":{"type":"number","description":"Total number of records available that match the request criteria, independent of pagination.","example":1,"minimum":0},"parties":{"description":"Individuals or entities associated with the policy, including identity, relationship, and servicing instructions.","type":"array","items":{"$ref":"#/components/schemas/IriPolicyParty"}}},"required":["startIndex","itemsCount","totalItemsCount","parties"]},"IriTransactionType":{"type":"string","description":"Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc","enum":["SubsequentPayment","OneTimePremium","PartialWithdrawalOneTime","SystematicPartialWithdrawal","RequiredMinimumDistributionOneTime","SystematicRequiredMinimumDistribution","FullSurrender","FundTransfer","FundAllocationsChange","Sweep","DollarCostAverage","NewLoan","LoanRepaymentOneTime","SystematicLoanRepayment","Annuitization","SystematicAnnuityPayout","PayoutAmountChange","ServiceCharge","RiderCharge","ValueAdjustment","InterestCredit","AddressChange","EmailChange","PhoneNumberChange","BeneficiaryChange","OwnerChange","BankAccountChange","CommunicationPreferenceChange","Reinstatement","Lapse","Other"]},"IriTransactionStatus":{"type":"string","description":"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","enum":["Pending","Completed","Failed","Reversed","Canceled","PendingReversal"]},"IriTransactionReason":{"type":"string","description":"The justification or business reason for the transaction","enum":["ONETIMEPREMIUM","GRACEPERIODPREMIUM","REINSTATEMENTPREMIUM","EXCHANGE1035","SURRENDER","AMOUNTEXCESSTOMEC","AMOUNTEXCESSTOGUIDELINE","CURRENTVALUE","COSTBASIS","GUIDELINESINGLEPREMIUM","GUIDELINELEVELPREMIUM","SEVENPAYPREMIUM","TOTALYTDPREMIUMAMOUNT","FACEDECREASECOVERAGE","INITIALPREMIUMEXPIRATION","COMPLIANCE","STARTINGPRICE","LUMPSUM","FIVEYEARDEFERRAL","SPOUSALCONTINUATION","DISCOUNT","CONTROLBUSINESSINDICATOR","NATIONALCHANGEOFADDRESS"]},"IriTransactionAmountType":{"type":"string","description":"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.","enum":["AMOUNT","PERCENTAGE","MAX","FREEWITHDRAWALAMOUNT","WITHDRAWALUNTILBASIS","EARNINGSONLY"]},"IriDisbursementType":{"type":"string","description":"Type of amount for withdrawal such as Gross or Net.","enum":["GROSS","NET"]},"IriDisbursementPaymentForm":{"type":"string","description":"Transaction disbursement payment form. Uses the recurring disbursement vocabulary with EFT; EXCHANGE is intentionally excluded because it applies only to party-level exchange servicing.","enum":["DTCC","EFT","ACH","CHECK","WIRE"]},"IriTransactionAmounts":{"type":"object","properties":{"requestedAmount":{"type":"number","description":"Required when amountType is AMOUNT. Must not be provided for PERCENTAGE, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or EARNINGSONLY.","example":137547.78,"minimum":0,"maximum":9999999999.99},"requestedPercentage":{"type":"number","description":"Required when amountType is PERCENTAGE. Must not be provided for AMOUNT, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or EARNINGSONLY.","example":10,"minimum":0,"maximum":100},"amountType":{"$ref":"#/components/schemas/IriTransactionAmountType"},"disbursementType":{"$ref":"#/components/schemas/IriDisbursementType"},"disbursementPaymentForm":{"$ref":"#/components/schemas/IriDisbursementPaymentForm"}}},"IriTransactionChargeType":{"type":"string","description":"Type of charge applied to the transaction.","enum":["SERVICE_CHARGE","RIDER_CHARGE","ADMINISTRATIVE_CHARGE","SURRENDER_CHARGE","MVA","TAX","COST_OF_INSURANCE","EXPENSE_CHARGE","UNIT_EXPENSE_CHARGE","WITHDRAWAL_CHARGE","OTHER"]},"IriTransactionCharge":{"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/IriTransactionChargeType"},"isChargeWaived":{"type":"boolean","description":"Whether the charge was waived.","example":false},"chargeWaiverReason":{"type":"string","description":"Reason the charge was waived.","example":"WITHIN_FREE_WITHDRAWAL"},"chargeAmount":{"type":"number","description":"Charge amount applied for this transaction.","example":374.75,"minimum":0,"maximum":9999999999.99},"chargeAppliedRate":{"type":"number","description":"Rate (%) used to calculate the charge.","example":0.27,"minimum":0,"maximum":9999999999.99}}},"IriTransactionExternalIdentifiers":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"Carrier payment reference number.","example":"EXT-REF-1001","pattern":"^[A-Za-z0-9._-]{1,100}$"},"externalTransactionId":{"type":"string","description":"Carrier-side transaction identifier.","example":"EXT-TX-1001","pattern":"^[A-Za-z0-9._-]{1,100}$"},"externalArrangementId":{"type":"string","description":"Carrier-side systematic program (arrangement) identifier.","example":"ARR-001","pattern":"^[A-Za-z0-9._-]{1,100}$"}}},"IriPolicyTransaction":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier assigned to the transaction.","pattern":"^[A-Za-z0-9._-]{1,100}$","example":"TX-1001"},"originalTransactionId":{"type":"string","description":"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","pattern":"^[A-Za-z0-9._-]{1,100}$","example":"TX-REF-0000"},"partyPolicyChangeReferenceId":{"type":"string","description":"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","pattern":"^[A-Za-z0-9._-]{1,100}$","example":"PAR-686"},"partyPolicyNewReferenceId":{"type":"string","description":"Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added","pattern":"^[A-Za-z0-9._-]{1,100}$","example":"PAR-908"},"planCode":{"type":"string","description":"The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration","pattern":"^[A-Za-z0-9._-]{1,50}$","example":"FIAPRM01"},"parentId":{"type":"string","description":"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","pattern":"^[A-Za-z0-9._-]{1,100}$","example":"ROOT-1"},"transactionType":{"$ref":"#/components/schemas/IriTransactionType"},"requestDate":{"type":"string","description":"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":"2026-03-06","format":"date"},"effectiveDate":{"type":"string","description":"Represents the date on which the policy or contract became active and coverage officially began.","example":"2026-03-06","format":"date"},"processDate":{"type":"string","description":"Represents the date when the transaction is processed by the system.","example":"2026-03-06","format":"date"},"reversalDate":{"type":"string","description":"The date when a transaction is reversed in the system","example":"9999-12-31","format":"date"},"status":{"$ref":"#/components/schemas/IriTransactionStatus"},"transactionReason":{"$ref":"#/components/schemas/IriTransactionReason"},"transactionAmounts":{"description":"Details of financial amounts associated with the transaction","allOf":[{"$ref":"#/components/schemas/IriTransactionAmounts"}]},"charges":{"description":"Charges applied as part of the transaction.","type":"array","items":{"$ref":"#/components/schemas/IriTransactionCharge"}},"taxWithholdingInstructions":{"description":"Tax withholding instructions associated with the transaction.","type":"array","items":{"$ref":"#/components/schemas/IriPartyTaxWithholdingInstruction"}},"timestamp":{"type":"string","description":"Create or update timestamp of the transaction event.","example":"2026-03-06T12:00:00Z","format":"date-time"},"isReverseInitiated":{"type":"boolean","description":"Whether the transaction was initiated as a reversal (reverse-and-reprocess).","example":false},"version":{"type":"integer","description":"Version number of the policy after the transaction.","example":1,"format":"int32"},"externalIdentifiers":{"description":"External identifiers associated with the transaction.","allOf":[{"$ref":"#/components/schemas/IriTransactionExternalIdentifiers"}]}},"required":["transactionId","planCode","requestDate","effectiveDate","processDate","status","transactionReason","timestamp","version"]},"IriPolicyTransactions":{"type":"object","properties":{"startIndex":{"type":"number","description":"Used for pagination to indicate where the returned page starts within the full result set.","example":0,"minimum":0},"itemsCount":{"type":"number","description":"Number of records included in the current response page.","example":1,"minimum":0},"totalItemsCount":{"type":"number","description":"Total number of records available that match the request criteria, independent of pagination.","example":1,"minimum":0},"transactions":{"description":"Transactions associated with the policy.","type":"array","items":{"$ref":"#/components/schemas/IriPolicyTransaction"}}},"required":["startIndex","itemsCount","totalItemsCount","transactions"]}}}}
```