Search
K
Policy

Systematic Programs

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms

Query Parameters

referenceIdstring
referenceTypestring

Allowed values:PartyIdBankIdAddressId

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

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

get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms
 
application/json

Systematic Programs for External Transaction Id

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}

Query Parameters

referenceIdstring
referenceTypestring

Allowed values:PartyIdBankIdAddressId

Path Parameters

planCodestringrequired
policyNumberstringrequired
externalIdstringrequired
externalIdTypestringrequired

Allowed values:ExternalTransactionIdReferenceNumberExternalArrangementId

Response

application/json

OK

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

get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}
 
application/json

Riders

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/riders

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

timestampstring(date-time)

TBD

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

typestring

Allowed values:BASERIDERBASEINCREASEINTEGRATEDRIDERRIDERINCREASEBENEFITDISCOUNTOTHERUNKNOWN

riderNamestring

The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit

Example:Chronic Illness Accelerated Death Benefit Rider

riderElectedstring

Indicates the election status of the rider on the policy, specifying whether the policyholder has formally elected to include the rider

Example:ELECTED

riderCodestring

A unique identifier or alphanumeric code assigned to the rider

Example:SBLCHR

underwritingStatusstring

Allowed values:APPROVEDDECLINED

unbornChildIndicatornumber

This will be set to yes if there is no Child rider insured to support Unborn Child

Allowed values:true

qualifiedAdditionalBenefitnumber

Indicates whether the rider provides a qualified benefit under IRS or insurance regulations

Allowed values:true

effectiveDatestring(date)

Date on which Rider is selected and becomes effective on the policy

Example:2023-01-01

exerciseDatestring(date)

The date the policyholder elects to use or activate the rider benefit

Example:2023-01-01

terminationDatestring(date)

The date on which the rider coverage ends/ is terminated

Example:2023-01-01

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

coverageIdstring

An unique identifier assigned to the rider coverage within an insurance coverage or policy layer

Example:Rider_SBLCHR

amountnumber

The total benefit amount the rider provides (separate from the base policy’s coverage.)

Example:0

annualBenefitAmountnumber(double)

The maximum benefit amount of the benefit base, policyholder can withdraw each year

Example:0

riderBenefitAmountnumber(double)

The Total Benefit Amount represents the maximum guaranteed amount available under the annuity rider over the life of the contract/rider

Example:0

riderBenefitPercentnumber(double)

The fixed percentage applied to the Rider Benefit Amount to calculate the annual guaranteed benefit amount

Example:100

minimumRiderBenefitAmountnumber(double)

Refers to a guaranteed payout to a beneficiary upon the death of the annuitant, regardless of the contract investment performance, as long as the annuity is in the accumulation phase. Used for Variable annuities

Example:0

growthIncomeBenefitAmountnumber(double)

The Growth Income Benefit value represents the guaranteed income base established under a Guaranteed Minimum Income Benefit (GMIB) rider. It is used to calculate the lifetime income payments the annuitant is entitled to upon annuitization, regardless of the contract actual account value.

Example:0

riderStoredIncomeBalancenumber(double)

Amount that can be withdrawn without reducing the yearly or Lifetime rider benefit amount

Example:0

riderParticipantarray[object]

Note - Use riderParticipants field instead of riderParticipant

Show Child Parameters
riderParticipantsarray[object]
Show Child Parameters
chargeobject
Show Child Parameters
maximumChronicIllnessBenefitPercentagenumber

The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage

Example:2.5

maximumPeriodicPaymentPeriodnumber

The maximum duration over which payments can be made under the rider ( in Months)

claimStatusnumber

The current status of a claim filed under the rider

Allowed values:true

nextEvaluationDatestring(date)

The date of the next scheduled review or re-evaluation of an ongoing claim (applicable for riders like chronic illness).

Example:2023-01-01

riderPaymentDatestring(date)

The date the benefit payout under the rider is to be disbursed to the policyholder or beneficiary

Example:2023-01-01

terminalRiderPaymentAmountnumber

The amount paid under the rider benefit.(during a given payout cycle)

Example:0

riderMinimumPaymentAmountnumber

Deprecated - kept for backwards compatibility

Example:0

maximumCriticalIllnessBenefitPercentagenumber

The highest percentage of the policy’s face amount that can be accessed under the critical illness rider

Example:0

tierOneMaximumCriticalIllnessBenefitPercentagenumber

The percentage of the benefit payable under Tier 1 of the critical illness structure (e.g., for mild conditions).

Example:0

tierOneMaximumCriticalIllnessBenefitAmountnumber

The maximum dollar amount payable under Tier 1 benefits

Example:0

tierTwoMaximumCriticalIllnessBenefitPercentagenumber

The percentage of the benefit payable under Tier 2(usually for more severe conditions.)

Example:0

tierTwoMaximumCriticalIllnessBenefitAmountnumber

The maximum dollar amount payable under Tier 2 benefits.

Example:0

tierOneCriticalRiderPaymentDatestring(date)

The date on which the Tier 1 critical illness rider benefit payment is scheduled or was made

Example:2023-01-01

tierOneCriticalRiderPaymentAmountnumber

The amount of benefit paid under the Tier 1 critical illness

Example:0

tierTwoCriticalRiderPaymentDatestring(date)

The date on which the Tier 2 critical illness rider benefit payment is scheduled or was made

Example:2023-01-01

tierTwoCriticalRiderPaymentAmountnumber

The amount of benefit paid under the Tier 2 critical illness

Example:0

coverageLayersarray[object]
Show Child Parameters
remainingBenefitnumber(double)

The remaining benefit amount for the rider. Incremented by Premiums and adjusted by withdrawals.

Example:10.51

additionalBenefitUsedUpnumber

Indicates whether the ADL benefit is utilised on the contract.

Allowed values:true

totalBenefitnumber(double)

The total guaranteed value the contract owner is entitled to at the end of the GMAB holding period — assuming no disqualifying withdrawals or events.

Example:5.17

payoutOptionstring

Single or Joint Payout (not driven by Owners on the policy, even a jointly owned policy can have single as an option. Used in configuration to set different GMWB benefits for Single and Joint GMWB Amount Types

Allowed values:SINGLEJOINT

benefitPercentnumber(double)

Ties to Withdrawal Reset Benefit % Annual Limit on Calender Processing if GMWB Anniversary Base reset is elected. Equals result of GMWB Benefit % equation box in Withdrawal tab (GMWB) Ku - Payout Factor Percentage of the benefit base that will be available for withdrawal each year

Example:1.23

annualBenefitLimitnumber(double)

GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events

Example:3.43

currentAnnualLimitnumber(double)

GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events

Example:5.45

remainingAnnualLimitnumber(double)

The GMWB amount still available for withdrawal in the current Contract Year without creating an “Excess Withdrawal” situation.

Example:6.75

hypotheticalAnnualLimitnumber(double)

During the riders accumulation phase (before it is exercised), a hypothetical annual withdrawal limit is calculated and displayed on statements to inform the policyholder and assist in their decision to exercise the rider

Example:8.95

phasestring

Indicator for whether the phase is Accumulation (not activated, benefit base is still accruing) or Income (annual limit calculated, benefit bases stop growing). Default value = Accumulation

Allowed values:ACCUMULATIONINCOME

lastResetDatestring(date)

User initiates the Reset, Variables product

Example:2023-01-01

baseobject
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/riders
 
application/json

Parties

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/parties

Query Parameters

partyRolestring

Allowed values:OwnerJointOwnerAnnuitantJointAnnuitantPayeePayorThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiaryGrantorTrusteePowerOfAttorney

partyIdstring

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

partyTypestring

Allowed values:INDIVIDUALORGANIZATIONTRUST

partyRoleIdstring

TBD

parentPartyIdstring

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

beneficiaryPercentagenumber(double)

Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary

Example:100

agentPercentagenumber(double)

Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent

Example:100

agentExternalIdstring

The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent

Example:3160000751

agentTypestring

Allowed values:ACCOUNTMANAGERADDITIONALCOMPENSATIONRECIPIENTADVANCEDUNDERWRITINGCONSULTANTAGENCYORGENERALAGENTAGENCYDIRECTORAGENCYSUPERINTENDENTAGENCYVICEPRESIDENTAGENTORPRODUCERASSISTANTASSISTANTGROUPUNDERWRITERASSISTANTMANAGERASSISTANTVICEPRESIDENTASSISTANTVPCOMPLIANCEASSOCIATEAGENCYMANAGERASSOCIATEFINANCIALPLANNERASSOCIATEOFFICERMANAGERASSOCIATESALEDEVELOPMENTMANAGERINTRAININGASSOCIATESALESDEVELOPMENTMANAGERBANKBANKEMPLOYEEBRANCHMANAGERBROKERBROKERORDEALERBROKERAGEDIRECTORBROKERAGEGENERALAGENTCERTIFIEDFINANCIALPLANNERDISTRIBUTORFINANCIALCONSULTANTFINANCIALPLANNERMANAGINGDIRECTORMANAGINGGENERALAGENTOFFICEMANAGEROTHERPLATFORMREPQUALIFYINGOFFICERREGISTEREDFINANCIALPLANNERREGISTEREDREPRESENTATIVESALESDEVELOPMENTMANAGERSECONDLINEMANAGERSENIORADMINISTRATIVECONSULTANTSENIORADVANCEDUNDERWRITINGCONSULTANTSENIORFINANCIALPLANNERSENIORGROUPACCOUNTEXECUTIVESENIORGROUPSALESREPRESENTATIVESENIORPARTNERSENIORSALESDEVELOPMENTMANAGERSENIORVICEPRESIDENTSERVICINGBROKERSERVICINGONLYAGENTSOLICITORTEAMUNKNOWN

firstNamestring

The first name of the party/trustee

Example:Karen

middleNamestring

The middle name of the party/trustee

Example:Anne

lastNamestring

The last name of the party/trustee

Example:Bates

fullNamestring

The full name of the party/The legal name of the Trust/Organization

Example:Karen Anne Bates

prefixstring

Allowed values:MRMSMISSMRSDR

suffixstring

The suffix of the party name

Allowed values:JRSNSRIIIIIIIVVVIVII

genderstring

Allowed values:MALEFEMALEUNISEX

dateOfBirthstring(date)

The date of birth of the party

Example:2023-01-01

genderIdentitystring

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

attainedAgeinteger(int32)

Age calculated by date of birth and Policy year

Example:55

birthCountrystring

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR

citizenCountrystring

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR

birthStatestring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

doingBusinessAsstring

The name the organization is commonly known as

Example:TBD

abbreviatedNamestring

The shortened/abbreviated version of the organization`s name that is unique to the organization

Example:TBD

organizationCodestring

Code to Identify organization

Example:TBD

entityTypestring

Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONUNKNOWN

trustDatestring(date)

The trust agreement issued date to the party

Example:2023-01-01

amendedTrustDatestring(date)

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

Example:2023-01-01

governingStateOfTruststring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

trustTypestring

Allowed values:INDIVIDUALTRUSTCORPORATETRUSTTESTAMENTARYTRUSTINTERVIVOSTRUSTGRANTORTRUST

trustTitlestring

The title of the trustee

Example:TBD

trustAccessCodestring

Access code of the trustee

Example:TBD

preferredCommunicationTypestring

Allowed values:EMAILREGULARMAILPHONEFAXTEXTNOPREFERENCESPECIFIEDPOSTALOTHER

preferredAddressIndicatorstring

Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section

Example:1

preferredAddressIdstring

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

preferredEmailIdstring

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

preferredPhoneIdstring

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

partyPercentagenumber(double)DEPRECATED

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

formerNameobject
Show Child Parameters
identificationsarray[object]
Show Child Parameters
taxWithholdingsarray[object]
Show Child Parameters
partyStatusstring

Allowed values:APPROVEDNOTAPPROVEDPROCESSED

isPartyBeneficiaryNonNaturalnumber

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

Allowed values:true

isIrrevocablenumber

An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms

Allowed values:true

isRequiredMinimumDistributionDesignatednumber

An indicator if the beneficiary is designated to be included in Joint RMD calculations

Allowed values:true

lastContactDatestring(date)

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

beneficiaryShareMethodstring

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.

Allowed values:PERSTIRPESDISTRIBUTION

partyIdstring

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

addressesarray[object]

Array of addresses associated with the party

Show Child Parameters
phonesarray[object]

Array of phone numbers associated with the party

Show Child Parameters
emailsarray[object]

Array of emails associated with the party

Show Child Parameters
bankDetailsarray[object]

Array of bank accounts associated with the party

Show Child Parameters
deathDetailsobject
Show Child Parameters
impairmentDetailsobject
Show Child Parameters
timestampstring(date-time)required

TBD

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

policyNumberstringrequired

Policy number

Example:ZH12345678

customerIdstringrequired

TBD

Example:0017b000010N4bCAAS

insuredobjectrequired
Show Child Parameters
versionnumber(int32)required

Example:1

get/policy/v1/policies/{planCode}/{policyNumber}/parties
 
application/json

Policy Illustration Information

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/lpspayload

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

LPSPayloadResponse

attributesobjectrequired

Attributes

Show Child Parameters
accountValueobjectrequired

Account Value

Show Child Parameters
testValueobjectrequired

Test Value

Show Child Parameters
deathBenefitobjectrequired

Death Benefit

Show Child Parameters
coverageValueobjectrequired

Coverage Value

Show Child Parameters
coveragesarray[object]required

Array of Coverages

Show Child Parameters
partiesarray[object]required

Array of Parties

Show Child Parameters
policyFeeobjectrequired

Policy Fee

Show Child Parameters
featuresobjectrequired

Features

Show Child Parameters
fundAllocationsarray[object]required

Array of Fund Allocations

Show Child Parameters
fundsarray[object]required

Array of Funds

Show Child Parameters
matchSegmentobjectrequired

Match Segment

Show Child Parameters
loanSegmentsarray[object]required

Array of Loan Segments

Show Child Parameters
arrangementsarray[object]required

Array of Arrangements

Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/lpspayload
 
application/json