Search
K
Policy

IriPolicyValue

object
valuesAsOfDatestring(date)required

Date the values are reported as of (yyyy-mm-dd).

Example:2026-03-31

accountDesignationstring

Account designation / role type.

Allowed values:INDIVIDUALJOINTTRUSTCUSTODIALOTHER

jurisdictionstring

Two-letter jurisdiction code.

Match pattern:^[A-Z]{2}$

Example:NC

sponsoringPlanSeparationDatestring(date)

Sponsoring plan separation date (yyyy-mm-dd).

Example:2026-01-01

payoutTypestring

Payout / product type.

Allowed values:DEFERREDIMMEDIATEANNUITIZEDACCUMULATIONUNKNOWN

totalDepositITDnumber

Total deposit inception-to-date.

>= 0<= 9999999999.99

surrenderChargeFreeDatestring(date)

Date surrender charges no longer apply (yyyy-mm-dd).

Example:2031-01-01

digitalPaymentTypeCodestring

Digital payment type code.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:ACH

digitalPaymentTypeDescriptionstring

Digital payment type description.

<= 100 characters

Example:Automated Clearing House

accountValuesobjectrequired
Show Child Parameters
loanValuesobject
Show Child Parameters
withdrawalValuesobject
Show Child Parameters
marketValueAdjustmentobject
Show Child Parameters
rmdInfoobject
Show Child Parameters
authorizationobject
Show Child Parameters
Example

IriPartyType

string

Type of party.

Allowed values:individualentity

IriPartyRelationship

string

Relationships the party has to the policy.

Allowed values:ownerjointOwnerannuitantjointAnnuitantprimaryBeneficiarycontingentBeneficiary

IriPartyPaymentForm

string

Party-level payment form. Bank details are required by the IRI schema for ACH, WIRE, and DTCC.

Allowed values:DTCCACHCHECKWIREEXCHANGE

IriBankAccountStatus

string

Status of the bank account.

Allowed values:ACTIVEBANKACCOUNTTERMINATEDBANKACCOUNT