Search
K
Policy

IriValidationError

object
codestringrequired

Structured error code classifying the business rule or decision failure.

Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$

Example:policy.inquiry.notFound

messagestringrequired

Why the error occurred / specific business rule violation.

Example

IriError

object
codestringrequired

A structured error code ...

Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$

Example:policy.inquiry.notFound

timestampstring(date-time)

Timestamp the error occurred.

messagestringrequired

Message with specific error details.

validationErrorsarray[object]

Logical rule violations related to business logic or rules.

Show Child Parameters
Example

IriAccountDesignation

string

Account designation / role type.

Allowed values:INDIVIDUALJOINTTRUSTCUSTODIALOTHER

IriPayoutType

string

Payout / product type.

Allowed values:DEFERREDIMMEDIATEANNUITIZEDACCUMULATIONUNKNOWN

IriAccountValues

object
beginningAccountValuenumber

Total cash value of the policy/annuity at the beginning of each transaction (loaned + unloaned).

>= 0<= 9999999999.99

Example:161.82

endingAccountValuenumberrequired

Total cash value of the policy/annuity (loaned + unloaned) as of the last processed transaction.

>= 0<= 9999999999.99

Example:161.82

minimumRequiredAccountValuenumber

Lowest account value that must be maintained to keep the contract active. May be 0 for some products.

>= 0<= 9999999999.99

unloanedPortionOfAccountValuenumber

Portion of the total account value that is not affected by policy loans.

>= 0<= 9999999999.99

Example:161.82

loanedPortionOfAccountValuenumber

Amount of the account value used as collateral for a policy loan.

>= 0<= 9999999999.99

surrenderValuenumber

Amount paid to the policyholder upon voluntary surrender, after charges, loans, and fees.

>= 0<= 9999999999.99

Example:161.82

surrenderValueWithoutMarketValueAdjustmentnumber

Surrender value without market value adjustment included.

>= 0<= 9999999999.99

Example:161.82

guaranteedCashSurrenderValueFixednumber

Minimum cash value guaranteed on surrender regardless of market conditions (fixed).

>= 0<= 9999999999.99

Example:161.82

guaranteedCashSurrenderValueIndexednumber

Indexed amount guaranteed on surrender. Only required for Annuity FIA products.

>= 0<= 9999999999.99

Example:161.82

interestEarnednumber

Interest credited to the policy/annuity based on the accumulated account value.

>= 0<= 9999999999.99

Example:12.34

totalNetWithdrawalSinceIssuenumber

Running total of all net withdrawals since policy issuance.

>= 0<= 9999999999.99

totalGainWithdrawnSinceIssuenumber

Total of all earnings withdrawn since policy issue.

>= 0<= 9999999999.99

Example