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.
Show Child Parameters
IriAccountDesignation
stringAccount designation / role type.
Allowed values:INDIVIDUALJOINTTRUSTCUSTODIALOTHER
IriPayoutType
stringPayout / product type.
Allowed values:DEFERREDIMMEDIATEANNUITIZEDACCUMULATIONUNKNOWN
IriAccountValues
objectTotal cash value of the policy/annuity at the beginning of each transaction (loaned + unloaned).
>= 0<= 9999999999.99
Example:161.82
Total cash value of the policy/annuity (loaned + unloaned) as of the last processed transaction.
>= 0<= 9999999999.99
Example:161.82
Lowest account value that must be maintained to keep the contract active. May be 0 for some products.
>= 0<= 9999999999.99
Portion of the total account value that is not affected by policy loans.
>= 0<= 9999999999.99
Example:161.82
Amount of the account value used as collateral for a policy loan.
>= 0<= 9999999999.99
Amount paid to the policyholder upon voluntary surrender, after charges, loans, and fees.
>= 0<= 9999999999.99
Example:161.82
Surrender value without market value adjustment included.
>= 0<= 9999999999.99
Example:161.82
Minimum cash value guaranteed on surrender regardless of market conditions (fixed).
>= 0<= 9999999999.99
Example:161.82
Indexed amount guaranteed on surrender. Only required for Annuity FIA products.
>= 0<= 9999999999.99
Example:161.82
Interest credited to the policy/annuity based on the accumulated account value.
>= 0<= 9999999999.99
Example:12.34
Running total of all net withdrawals since policy issuance.
>= 0<= 9999999999.99
Total of all earnings withdrawn since policy issue.
>= 0<= 9999999999.99
IriLoanValues
objectOutstanding loan amount including principal, accrued interest, and unpaid loan charges.
>= 0<= 9999999999.99
Original amount borrowed against the cash value, excluding accrued interest or charges.
>= 0<= 9999999999.99
Total amount required to fully repay the policy loan, including accrued interest and adjustments.
>= 0<= 9999999999.99
Highest amount that can be borrowed against the cash value.
>= 0<= 9999999999.99
Smallest amount that can be borrowed against the cash value.
>= 0<= 9999999999.99
Interest accrued on the policy loan within the current year.
>= 0<= 9999999999.99
Last policy anniversary date when loan interest was due on an outstanding loan (yyyy-mm-dd).
Example:2023-01-01
Total count of policy loans taken over the life of the policy.
>= 0
Total amount of policy loans taken within the current calendar or policy year.
>= 0<= 9999999999.99