Role
objectRole type. Owner, Annuitant, Servicing Agent and Writing Agent are mandatory.
Allowed values:OWNJNTOWNPRIMBENECONTBENEMRDDESGBENEEXCCOMPANYANNJNTANNPAYORPAYEEASSIGNEEPRIMWRITAGTADDWRITAGTNONCOMAGTPRIMSERAGT
Example:OWN
string($9(01) V9(09) for percentage. Total percentage of a role should be 100%.
Example:100
The name type associated with the role.
Allowed values:INDORGTRUSTOTHERUGMACOMPANY
Example:IND
First name of the party role
Example:firstName when name type is Natural/Individual
Middle name of the party role
Example:B
Last name of the party role
Example:Doe
Prefix
Example:Dr
Suffix
Example:Sr
Date of birth of party role. Mandatory for Owner and Annuitant (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
Any one of the possible value for the gender.Mandatory for Owner and Annuitant.
Allowed values:MALEFEMALEUNISEXOTHER
Example:MALE
Country codes, Mandatory for Owner and Annuitant.
Allowed values:ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSAUYUZVAVCVEVGVIVNVUWFWSXKYEYTZAZMZW
9 digit Social Security number. Mandatory for Owner , Annuitant and Agent.
Match pattern:\d{9}
>= 9 characters<= 9 characters
Example:123456789
CRD number for the party role, used as Agent Identifier.
Example:123456
NPN number for the agent, used as Agent Identifier.
Example:123456
Distributor assigned Id for an agent, used as Agent Identifier.
Example:ABC0000000
Internal identifier assigned to the agent by carrier, used as Agent Identifier.
Example:ABC0000000
Unique number assigned by the MCS system, used as Agent Identifier.
Example:ABC0000000
One phone is mandatory for Owner and Annuitant
Show Child Parameters
Relationship code
Allowed values:TRUSTEETRUSTEEOFMINORBROTHERCHILDDAUGHTERFATHERFIANCEEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHERGRANDFATHERGRANDMOTHERDOMPARTNERAUNTNEPHEWNIECEHUSBANDWIFEUNCLEEMPLOYERGRANDPARENTLEGALGUARDIANTRUSTEEOFINCOMPPWROFATTRNYCNTRLNGPRSNOFENTEXECUTORSASSOCIATEPARTNERESTATETRUSTGRANDSONGRANDDAUGHTERPARENTNONSPOUSECHILDRENEQUALLYCHILDRENPERSTIRPESPERSTIRPESSURVIVNGSPOUSE
Example:SELF
One address is mandatory for Owner and Annuitant
Show Child Parameters
Type of trust & TrustType is required when the role is a trust
Allowed values:INDIVIDUALCORPORATE
Example:INDIVIDUAL
eDelivery is required/not for the role
Allowed values:YESNO
Example:YES
Email for associated party, email when eDelivery is ‘Y’.
Example:abc@zinnia.com
Show Child Parameters
Date of Death (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
SpecialProgram
objectspecialProgramType selected
Allowed values:PAYOUTRMDSYSWITHDRAWALPREMIUMDEFAULTDOLLARCOSTAVERAGESYSPARTIALWITHDRAWGROSSAUTOREBALANCEMINREQUIREDDISTEFTDRAWANNUITYPAYMENTDEFAULTSCHARGEDEDUCTIONEFTLOANREPAYREGINVESTADVISORFEERIDERCHARGECOVEREDPERSONAGEBAND60DAYHHCDRECERTLETTER45DAYHHCDRECERTLETTER60DAYGMWBROLLUPRNWLNOTICE45DAYGMWBROLLUPRNWLNOTICE60DAYGMDBROLLUPRNWLNOTICE45DAYGMDBROLLUPRNWLNOTICE72TQDISTGMIBTERMIBGROWTHLOCKDATELOANREPAY
Example:PAYOUT
Effective date of Special program (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
Frequency of special program
Allowed values:DLYBIWKLYMNTHLYSEMIANNQTRLYANNUALSNGLPMTBIMNTHLY
Example:DLY
amountType of special program
Allowed values:AMTPCTMAXFREEWDAMTWDUNITBASISPRORATA
Example:AMT
Stores the allocated percent to the specific fund
Example:50.5
Distribution Code
Allowed values:DEFPRMTRDISTERLYDISTEXCEPAPPDISBDTHCLMDTHEXCPROHIBTRANSSEC1035EXCNRMLDISBEXCSCNTRIBCURRYRTXPS58COSTS10YRTAXOPTEXCSCONTRIB2YRPRIORTXEXCSANNADDNLASSEC415CHARGIFTANNDIRROLLIRADIRROLLQUALPLNTSADISTFROMROTHIRALOANSASDISTQUALLOANNDISTPRMTRLOANDISTDISTFROMEDIRAEXCSCONTRIB1YRPRIOREXCSCONTRIBPLUSEARNRECHARIRAPREVYRERLYDISTRIBSIMPLESEPSERVTRSTTOTRSTIRATOROTHQDROROLLIRADTHROLLIRADTHTRANSQDROLIKETOLIKEQDROPMTTOSPSEFRSTHMBYRIRAONLYEDCTNEXPMEDEXPNONTAXEVNTGROSSPDATRNYOTHERINCNONEMPCOMPPRMTREXROYALTIESDIRTRANSROTHIRANORMDISTRIBRECHARIRACURRYRFEEADMINFEEASSETFEECONTRIBFEELUMPSUMDEATHFEELUMPSUMDISBFEELUMPSUMPURCHANNFEELUMPSUMOTHFEELNEWRETPERPMNTFEEEXISTINGRETINFORCEFEECONTFEEEXISTINGRETINCFEETHIRDPARTYLUMPSUMDEATHLUMPSUMDISBLUMPSUMPURCHANNLUMPSUMOTHFEEIPGEXPFROMFUNDRELRESRVHEALTHDEDFEEMRKTVALFEEANNADMINSECT1035EXCPARTQDRONORMDISBQDROSEC1035DESGROTHACCTDISTREPDTHBEN6050YDISTTRADINDVNOTFMVDIVDISTEMPSTK404KCOSTCURRLIFEINSURPROTECTDISTUNDEREMPLOYEEPLANSCOMPLRESSYSEXCSCONTRIBPLUSEARN2024FEELONGTERMCAREINSURQUALPLANLOANOFFSETQUALROTHINDVARRDISTROTHIRADISTEXCEPAPPLIES
Example:DEF
Specifies how many times special program will be run
Example:5
Show Child Parameters
Show Child Parameters
Date (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
First payment year.
Example:2025
Gross disbursment.
Example:10000
Waive charges.
Example:1000
Date (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
Prior RMD amount type.
Example:-999
Prior RMD amount.
Example:100
ExchangeReplace
objectFor any payment that is a replacement/exchange
Exchange policy product type
Allowed values:ANNUITYLIFEBROKERAGECASH
Example:ANNUITY
Name of the Company
Example:ABC
Company Tax ID
Match pattern:\d{9}
>= 9 characters<= 9 characters
Example:123456789
Type of the Exchange/Replacement
Allowed values:INT1035EXT1035EXTDIRTRANINTDIRTRANEXTROLLQUALINTROLLQUALEXTROTHROLLINTROTHTROLLEXTROTHDIRTRANINTROTHDIRTRANCLIENTINITTRANBENPRCDSEXT1035PARTINT1035PARTBIRTHRPMTNOLOAEXTDIRECTTRANSFREPINTDIRECTTRANSFREPREINSTATEMENTDEFAULT
Example:INT1035
Company email address
Example:abc@zinnia.com
Show Child Parameters
This field stores the requested amount.
Example:5000.55
Signed date (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
This field stores the source policy number
Example:123456
This field stores the Original Cost Basis
Example:1000
This field stores the plan type which was used on previous policy - Refer qualificationflag for types
Example:NONQUAL
This field stores determines whether to apply Rate Lock or not
Allowed values:YESNO
Example:YES
Allowed values:YESNO
Example:YES
Source of ER policy is MEC/not
Allowed values:YESNO
Example:YES
Withholding
objectThe amount to be withheld if withholding is selected
Example:100.5
Qualifies the withholding amount. Either as dollars or a percentage
Allowed values:DOLLARPERCENT
Example:DOLLAR
This will be used to indicate the type of withholding information for this instance of the Withholding Amount. This is in reference to the IRS W-4P and W-4R tax withholding forms
Allowed values:JOBORPENEXTRAOTHRDEDOTHRINCCLMSNCREDDEFAULTNOWITHUSEVALUES
Example:JOBORPEN
Defines the withholding authority for which is being withheld
Allowed values:STFEDLOCALNRABACKUP
Example:FED
Payment
objectUnique Id to tag to respective payment records. Duplicate Ids will be rejected.
Example:payment_1
Payment methods
Allowed values:CHKWIREEXCREPCREDITCARDACHDTCC
Example:CHK
Gross Amount for the individual payment
Example:238500.5
Net Amount for the individual payment
Show Child Parameters
Funds to be considered for Future Allocations or not
Allowed values:YESNO
Example:YES
waivePremium
This is same as Tracking ID.If there are multiple payments, first payment distributorId will be the TrackingID. This unique system generated number is assigned by the B/D system and sent with each premium to the NSCC, to send to the Insurance Company. This number is assigned by the broker dealer, by which the premium can be located. Required for clearing house and detail level transactions. Broker/dealer would expect this back for chargebacks, reversals, etc. Can be returned on the “FAR” and the “COM” by the insurance carrier to identify the transaction processed.
For any payment that is a replacement/exchange