Policy Transactions
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
EligibilityV3Target
objectThe target of the eligibility check.
typestringrequired
Target type.
Allowed values:RIDERCOVERAGEBENEFIT_OPTIONTRANSACTION
codestringrequired
Target code or identifier.
Example:CITR
Example
EligibilityV3Reason
objectStructured reason for an ineligible transaction.
codestring
Machine-readable reason code.
Example:BPM.NM.050
messagestring
Human-readable explanation.
Example:The effective date entered is not within this policy's free look period.
resolutionstring
Suggested remediation.
Example:Update the effective date (if possible), or submit for NIGO processing.
Example
IdentifierInstance
objectAn object representing an identifier and its corresponding value.
identifierstring
The type of identifier.
Allowed values:eAppIdpolicyNumber
valuestring
The value of the identifier.
Example:ABC123349257367
Example