IriTaxRateToUse
stringSelected tax rate source.
Allowed values:NOWITHHOLDINGELECTEDUSEVALUESENTEREDNOWITHHOLDINGALLOWEDUSEDEFAULTTABLE
IriFilingStatus
stringTax filing status. Usually populated when default withholding tables are used.
Allowed values:SINGLEDOMESTICPARTNERSHIPDEFAULTMARRIEDHEADOFHOUSEHOLDWIDOWEDDIVORCED
IriPartyTaxWithholdingInstruction
objectImpacted party details for withholding.
Show Child Parameters
Type of tax withholding.
Allowed values:FEDERALSTATENRABACKUP
Selected tax rate source.
Allowed values:NOWITHHOLDINGELECTEDUSEVALUESENTEREDNOWITHHOLDINGALLOWEDUSEDEFAULTTABLE
Tax filing status. Usually populated when default withholding tables are used.
Allowed values:SINGLEDOMESTICPARTNERSHIPDEFAULTMARRIEDHEADOFHOUSEHOLDWIDOWEDDIVORCED
Fixed dollar amount to withhold. Mutually exclusive with percentage.
>= 0<= 9999999999.99
Example:125
Percentage rate to withhold. Mutually exclusive with dollar.
>= 0<= 100
Example:10
Requested exemptions value.
>= 0<= 99
Jurisdiction for tax purposes. Required by the IRI schema when taxWithholdingType is STATE.
<= 50 characters
Example:NC
IriPartyDeathDetails
objectDate on which the insured or annuitant died.
Example:2026-03-06
Documented reason or medical determination for death.
<= 100 characters
Example:Natural causes
Date on which the carrier was notified of the death.
Example:2026-03-07
Date the appropriate death paperwork was received.
Example:2026-03-10
IriPolicyParty
objectType of party.
Allowed values:individualentity
First name of the individual party.
>= 1 characters<= 100 characters
Example:John
Middle name of the individual party.
>= 1 characters<= 100 characters
Example:Q
Last name of the individual party.
>= 1 characters<= 100 characters
Example:Public
Entity name of the party.
>= 1 characters<= 100 characters
Example:Public Family Trust
Tax identification number for the party.
Match pattern:^[0-9]{9}$
>= 9 characters<= 9 characters
Example:123456789
Relationships the party has to the policy.
Allowed values:ownerjointOwnerannuitantjointAnnuitantprimaryBeneficiarycontingentBeneficiary
>= 1 items<= 6 items
Party-level payment form. Bank details are required by the IRI schema for ACH, WIRE, and DTCC.
Allowed values:DTCCACHCHECKWIREEXCHANGE
Percentage share assigned to the party.
>= 0<= 100
Example:100
Financial institution details.
Show Child Parameters
Physical or mailing address details.
Show Child Parameters
Phone numbers associated with the party.
Show Child Parameters
Email addresses associated with the party.
Show Child Parameters
Identifications associated with the party.
Show Child Parameters
Tax withholding instructions associated with the party.
Show Child Parameters
Death details associated with the party.