Policy Transactions
RestrictedTransactionResult
objectA transaction affected by a restriction type, with its blocking status.
typestring
Transaction type code.
Example:FullSurrender
statusstring
How the transaction is blocked (e.g. Unavailable, CarrierApprovalNeeded).
Example:Unavailable
labelstring
Display label for the blocking status.
Example:Unavailable
Example
EligibilityErrorResponse
objectError envelope returned by eligibility endpoints on 4xx/5xx responses.
statusinteger
Example:401
errorstring
Example:Unauthorized
messagestring
Example:partyId claim could not be extracted
Example
EligibilityV3Request
objectOptional request body. When omitted or empty, all configured transactions are evaluated.
transactionGroupstring
Filter results to a specific transaction group.
Example:FirstYearTxn
transactionTypesarray[string]
Filter results to specific transaction types.
Example:RiderChange, DBOChange
Example
EligibilityV3TransactionResult
objectEligibility evaluation results for a transaction type.
transactionGroupstring
Transaction group (from request or configuration).
Example:FirstYearTxn
transactionTypestringrequired
Transaction type.
Example:RiderChange
resultsarray[object]required
Eligibility check result for a transaction, action, and target combination.
Show Child Parameters
Example
EligibilityV3CheckResult
objectEligibility check result for a transaction, action, and target combination.
eligibilityTypestringrequired
Type of eligibility check.
Allowed values:POLICYUSERRESTRICTION
actionstringrequired
Action being evaluated.
Allowed values:ADDUPDATEDELETEINCREASEDECREASENOT_APPLICABLE
targetobjectrequired
The target of the eligibility check.
Show Child Parameters
eligiblebooleanrequired
Whether the action is eligible for the target.
reasonsarray[object]
Structured reason for an ineligible transaction.
Show Child Parameters
Example