Search
K
Policy

Party

object
partyRolestring

Note -Use systematicProgram.parties.partyRole field instead of systematicProgram.party.partyRole

Allowed values:PAYORPAYEE

Example:PAYOR

partyIdstring

Note -Use systematicProgram.parties.partyId field instead of systematicProgram.party.partyId

Example:Party_PI_1

percentagenumber(double)

Note -Use systematicProgram.parties.percentage field instead of systematicProgram.party.percentage

Example:10

bankIdstring

Note -Use systematicProgram.parties.bankId field instead of systematicProgram.party.bankId

Example:Bank_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

Example

SystematicProgramParties

object
partyRolestring

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)

Allowed values:PAYORPAYEE

Example:PAYOR

partyIdstring

Role ID of the party

Example:Party_PI_1

percentagenumber(double)

The party percentage for this program

Example:10

bankIdstring

Bank Account Tied to the Party

Example:Bank_1

addressIdstring

Address Tied to the Party ID. In case of payment method Check , this field is required

Example:1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

forBenefitOfOrForFurtherCreditstring

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

Example

SystematicProgram

object
arrangementTypestring

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

arrangementIdstring

The unique payment number for payments by the party

Example:Arr_1

allocationOptionTypestring

Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY

reasonstring

Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION

numberOfOccurrencenumber(int32)

Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program

Example:12

disbursementTypestring

Allowed values:GROSSNETNETNET

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

frequencystring

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

requestedDatestring(date)

The date on which the request for the systematic program was submitted

Example:2023-01-01

startDatestring(date)

The date when the systematic program begins executing payments or transfers (entered by user)

Example:2023-01-01

endDatestring(date)

The date Special Program ends (Entered by user or determined by LPS based on Account Value)

Example:2023-01-01

previousProgramDatestring(date)

The last date on which a systematic transaction was processed

Example:2023-01-01

optedNextProgramDatestring(date)

A user-selected or modified next payment date, different from the scheduled one

Example:2023-01-01

nextProgramDatestring(date)

The date on which the next payment is scheduled

Example:2023-01-01

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

amountnumber(double)

A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program

Example:600

partyarray[object]

Note -Use systematicProgram.parties field instead of systematicProgram.party

Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired

The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program

Example:arrangementid123

Example

FeatureType

string

Allowed values:FREELOOKLAPSEASSESSMENTLAPSEPROTECTIONREINSTATEMENTRATELOCKANNUITIZATIONNONFORFEITUREOPTIONCONVERSIONDISCOUNTBILLINGCUSTOMFEATURE

PolicyFeature

object
featureTypestring

Allowed values:FREELOOKLAPSEASSESSMENTLAPSEPROTECTIONREINSTATEMENTRATELOCKANNUITIZATIONNONFORFEITUREOPTIONCONVERSIONDISCOUNTBILLINGCUSTOMFEATURE

featureIndicatornumber

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

Allowed values:true

featureOptionstring

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

Allowed values:LIFEONLYJOINTLIFEONLYJOINTANDSURVIVORPERIODCERTAINAMOUNTCERTAINLIFEWITHPERIODCERTAINLIFEWITHCASHREFUNDLIFEWITHINSTALLMENTREFUNDAUTOMATICPOLICYLOANREDUCEDPAIDUPAGEFACEAMOUNTLEGALOPERATIONALCOLLATERALLYASSIGNEDUNSPECIFIED

reducedPaidUpFaceAmountnumber(double)

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

startDatestring(date)

Start date of the feature

Example:2023-01-01

endDatestring(date)

End date of the feature

Example:2023-01-01

statusnumber

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

Allowed values:true

periodnumber(int32)

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

effectiveDatestring(date)

Effective date of the feature

Example:2023-01-01

totalRequiredAmountnumber(double)

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

totalMinimumRequiredAmountnumber(double)

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)

paymentAmountnumber(double)

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

exclusionAmountnumber(double)

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

yearToDatePaymentAmountnumber(double)

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

exclusionRationumber(double)

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

totalPaymentAmountnumber(double)

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

jointLivesPercentageToSurvivornumber(double)

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

underwritingDecisionnumber

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

Allowed values:true

approvalDatestring(date)

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

Example:2023-01-01

featureIdstring

Unique identifier of feature sub-type for "custom feature

Example:123

frequencystring

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

featureSubTypestring

Gives the sub type of the feature type "Custom Feature

Allowed values:MULTIPLEPOLICYDISCOUNTCONTROLBUSINESSINDICATORRESTRICT

timestampstring(date-time)

TBD

Example:2023-01-01T12:00:00.000Z

Example