IriRestrictionReason
objectRestriction category. Enum values use underscore-delimited tokens.
Allowed values:PRODUCT_RULECONTRACTAUTHORIZATION_IDENTITYTRANSACTIONARRANGEMENTPARTY_CONTRACT_DATA
Restriction sub-category.
Allowed values:TRANSFER_NOT_ELIGIBLESTATUS_OR_GLOBAL_RESTRICTIONRESTRICTED_TRADES_FLAGAGENT_NOT_AUTHORIZEDSHORT_TERM_TRADING_LIMITANNUAL_TRANSFER_LIMIT_EXCEEDEDENROLLMENT_CONFLICTCONFLICTING_TRANSACTION_PENDINGCOLLATERAL_ASSIGNMENTRECENT_OWNER_CHANGERECENT_ADDRESS_CHANGELOAN_OUTSTANDINGCONFLICTING_RIDERCONFLICTING_ARRANGEMENTPRODUCT_RULESEXCESSIVE_TRADING_RESTRICTIONNO_SIGNATURE_ON_FILEINVALID_GOVT_IDWITHDRAWAL_FULL_LIQUIDATIONWITHDRAWAL_SPECIFIED_AMOUNTWITHDRAWAL_SPECIFIED_PERCENTAGEWITHDRAWAL_INTEREST_ONLYWITHDRAWAL_RMDWITHDRAWAL_RIDER_FREE_AMOUNTWITHDRAWAL_SURRENDER_FREE_AMOUNTWITHDRAWAL_FUND_SPECIFICWITHDRAWAL_PRORATAWITHDRAWAL_PRORATA_VARIABLE_FUNDSWITHDRAWAL_SYSTEMATICDCA_RESTRICTIONSWEEP_RESTRICTIONREBALANCE_RESTRICTIONINVEST_RESTRICTIONPRORATA_INVEST_RESTRICTIONPRORATA_VARIABLE_FUNDS_INVEST_RESTRICTIONFUND_SPECIFIC_INVEST_RESTRICTIONWITHDRAWAL_RMD_CARRIER_CALC
Human-readable reason for the restriction.
>= 1 characters<= 200 characters
Example:Collateral Assignment
Definition/detail of the restriction.
>= 1 characters<= 500 characters
Example:Collateral assignment on the contract
IriIssueType
stringUnderwriting/issue type.
Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEED
IriPolicySummary
objectPolicy effective date (yyyy-mm-dd).
Example:2021-01-15
CUSIP identifier for the product.
Match pattern:^[0-9]{3}[A-Z0-9]{5}[0-9]$
>= 9 characters<= 9 characters
Example:78462F103
Carrier identifier.
<= 10 characters
Example:CARR123
Carrier display name.
<= 200 characters
Example:Contoso Life & Annuity
Timestamp the policy data was last refreshed.
Example:2026-03-06T16:30:00Z
Show Child Parameters
Tax qualification type.
Allowed values:Non-QualifiedSolo 401k401k403b457 Deferred CompensationInherited IRAIRA SpousalEducational IRAIRAIRA RolloverIRA TransferRoth IRARoth IRA - InheritedSEP IRASIMPLE IRAPension PlanCash Balance Plan-Defined ContributionsSolo Defined BenefitCash Balance Plan-Defined BenefitProfit Sharing PlanMoney Purchase PlanSAREP401gHR10Welfare Benefit PlanRoth 401KRoth 403bRoth 457
Policy status.
Allowed values:PENDINGISSUEDACTIVELAPSEDSURRENDEREDTERMINATED
Whether the policy has one or more active restrictions.
Example:true
Active restrictions. Required when hasRestriction is true.
Show Child Parameters
Underwriting/issue type.
Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEED
Two-letter issue state code.
Match pattern:^[A-Z]{2}$
Example:NC
ISO 4217 three-letter currency code.
Match pattern:^[A-Z]{3}$
Example:USD
IriValidationError
objectStructured error code classifying the business rule or decision failure.
Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$
Example:policy.inquiry.notFound
Why the error occurred / specific business rule violation.
IriError
objectA structured error code ...
Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$
Example:policy.inquiry.notFound
Timestamp the error occurred.
Message with specific error details.
Logical rule violations related to business logic or rules.