Search
K
Policy

ScheduledEventDetail

object
sde_idstring
eventTypestring
statusstring
frequencystring
systematicProgramRequestDatestring(date-time)
systematicProgramStartDatestring(date-time)
systematicProgramEndDatestring(date-time)
nextSystematicProgramDatestring(date-time)
Example

NotesDetail

object
Prioritystring

Priority of the note

Datestring(date-time)

Date of the note

Summarystring

Summary of the note

Note_Categorystring

Category of the note

Typestring

Type of the note

Notesstring

Detailed notes

Example

PolicyData

object
policyNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

policyStatusstring

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

productNamestring
prodModelCodestring
lOBstring
planNamestring

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

planCodestring

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

formIDstring
issuingCompanystring
deathIndicatorboolean
seriesIndicatorTokenNumberstring
issueStatestring

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

residentStatestring
valuesAsOfDatestring
totalDeathBenefitnumber(date-time)
baseFaceAmountnumber
initialFaceAmountnumber
fundValuenumber
indexFloornumber
indexCapnumber
partRatenumber
cashValuenumber
currentBilledPremiumnumber
billingModeCodestring
billingModestring
billingTypestring
yTDPremiumsPaidnumber
cumulativePremiumsPaidnumber
guidelinePremiumsPaidnumber
get_1035ExchangeHistoryarray[string]
premiumHistoryarray[object]
Show Child Parameters
totalWithdrawalsToDatenumber
distributionHistoryarray[object]
Show Child Parameters
mECStatusCodeboolean
ownerobject
Show Child Parameters
insuredarray[object]
Show Child Parameters
deathBenefitOptionobject
Show Child Parameters
noLapseGuaranteeYearsinteger(int32)
guaranteedCreditingRatenumber
fundPortfolioAllocationarray[object]
Show Child Parameters
coveragesarray[object]
Show Child Parameters
riderarray[object]
Show Child Parameters
tableRatingCodestring
tableRatingstring
qualifiedPlanCodeboolean
qualifiedPlanDescriptionstring
loanInterestRatenumber
seriesIndicatorstring
defofLifeInsuranceCodestring
defofLifeInsurancestring
clientFullNamestring
currentDeathBenefitAmountnumber
permanentFlatExtraPer$1000Amountnumber
additionalTemporaryFlatExtranumber
primaryInsuredPermanentFlatExtranumber
cashValueatLastMaterialChangenumber
dateofLastMaterialChangestring
premiumPaidOnTheLastMaterialChangenumber(date-time)
totalPremiumsPaidSinceLastMaterialChangenumber
healthyMeasureRewardIndicatorboolean
uLRedeterminationFactorstring
aSVReportRequestedstring
accountInterestRatenumber
deemedCashValuenumber
totalModalPremiumnumber
totalPartialSurrenderChargeSinceInceptionnumber
nARWeightingnumber
assumedInterestRatenumber
inforceIndicatorboolean
sevenPayBasenumber
preferredLoanAccountValuenumber
preferredLoanInterestnumber
preferredLoanInterestRatenumber
preferredLoanPrincipalnumber
preferredLoanCollateralnumber
netAmtAtRisknumber
premChargesnumber
eOYBaseCashValuenumber
reinstatementFullPaymentnumber
reinstatementFullPaidTostring
reinstatementAdjPaymentnumber
eOYCashValuenumber
loanAccruedInterestnumber
surrenderChargenumber
netSurrenderValuenumber
accountValuenumber
projectIndicatorstring
agentstring
loanPrincipalnumber
loanAccountValuenumber
loanAccruedInterestEOYnumber
cumulativeGLPnumber
costBasisnumber

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

currentDeclaredRateDatestring
currentAccountInterestRatenumber
guaranteedInterestAccountRatestring
guaranteedInterestAccountDeclaredDatestring
longTermGIARatestring
nLGModalPremiumnumber
nLGCumulativePremiumnumber
nLGCumulativePremiumwithInterestnumber
cumulativePremiumnumber
shadowFundRateAnumber
shadowFundRateBnumber
shadowFundRateCnumber
shadowFundThresholdValueAnumber
shadowFundThresholdValueBnumber
shadowFundThresholdPremiumAnumber
shadowFundThresholdPremiumBnumber
shadowFundAccountValuenumber
benchmarkAmountstring
benchmarkBonusRatestring
unisexstring
iULFixedAccountnumber
iULIndexedAccountAstring
iULIndexedAccountBstring
iULFixedAllocationnumber
iULIndexAAllocationstring
iULIndexBAllocationstring
iULFixedInterestRatenumber
iULIndexedAccountAInterestRatestring
iULIndexedAccountBInterestRatestring
loanInterestTypestring

Allowed values:FIXEDINDEXEDVARIABLEADJUSTABLE

imputedInterestRatenumber
requiredPremiumDuenumber
seriesIndicatorOverridestring
healthyMeasureRewardYearsinteger(int32)
tier2RequiredPremAccumnumber
tier3RequiredPremAccumnumber
tier4RequiredPremAccumnumber
tier1RequiredAmtDuenumber
tier2RequiredAmtDuenumber
tier3RequiredAmtDuenumber
tier4RequiredAmtDuenumber
nLGGraceEndDatestring
tier2GraceEndDatestring(date-time)
tier3GraceEndDatestring(date-time)
tier4GraceEndDatestring(date-time)
multiTierRequiredAmtDuenumber
requiredAmountDuenumber
longTermGIARateDeclaredDatestring(date-time)
loanRepaymentModestring
loanRepaymentAmountstring
lapseProtectionIndicatorboolean
policyOptionstring
pastDueChargesnumber
lapsePendingEndDatestring(date-time)
leastDeathBenefitnumber
paidToDatestring(date-time)

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)

accumulatedWithdrawalsnumber
issueRiskClassstring
bandstring
accruedLoanInterestnumber
currentInterestRatenumber
borrowedFundRatenumber
borrowedFundValuenumber
nonNYInforceIllustrationstring
unvestedMatchValuenumber
matchCumulatePaymentsSinceIssuenumber
matchYearToDatePaymentsnumber
priorMonthCOInumber
monthlyAdminFeenumber
current7PayAnnualAccumnumber
currentGuidelineAnnualPremiumAccumnumber
guidelinePremiumAnnualnumber
lowestDeathBenefitForMECCalculationnumber
numberOfWithdrawalsTakenThisYearnumber
withdrawalsTakenYTDnumber
accountValueAtBOYnumber
lapseProtectionGuaranteePremiumnumber
sumOfMonthlyNoLapseGuaranteedPremiumsSinceIssuenumber
productVersionstring

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

faceAmountnumber
cumPremForGDBstring
bankDetailsarray[object]
Show Child Parameters
policyValuesarray[object]
Show Child Parameters
scheduledEventDetailsarray[object]
Show Child Parameters
notesDetailsarray[object]
Show Child Parameters
eoycashValuenumber
nlgmodalPremiumnumber
nlgcumulativePremiumnumber
nlgcumulativePremiumwithInterestnumber
iulfixedAccountnumber
iulindexedAccountAstring
iulindexedAccountBstring
iulfixedAllocationnumber
iulindexAAllocationstring
iulindexBAllocationstring
iulfixedInterestRatenumber
iulindexedAccountAInterestRatestring
iulindexedAccountBInterestRatestring
nlggraceEndDatestring(date-time)
lobstring
ytdpremiumsPaidnumber
mecstatusCodeboolean
ulredeterminationFactorstring
asvreportRequestedstring
narweightingnumber
eoybaseCashValuenumber
Example

GetIllustrationPolicyInfo

object
policyDataobject
Show Child Parameters
messageResponseobject
Show Child Parameters
Example

GetLoans

object
loanobject
Show Child Parameters
loanFundValueobject
Show Child Parameters
loanValuesobject
Show Child Parameters
messageResponseobject
Show Child Parameters
Example