TransactionEligibilitySubjectResult
objectComposed eligibility result for a single transaction subject. Null fields are omitted from the JSON response. Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Transaction type identifier evaluated.
Example:FullSurrender
Overall eligibility. true only when policy and user sections are ELIGIBLE and restriction is not HARD_RESTRICTED.
One child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Show Child Parameters
One child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Show Child Parameters
Restriction section of a per-subject result. status values: NOT_RESTRICTED, SOFT_RESTRICTED, HARD_RESTRICTED, COULD_NOT_DETERMINE. The access array lists all configured blocking restrictions for the transaction; it is present on restriction sections and omitted from policy/user sections.
Show Child Parameters
True when the subject is absent from product-transactions for this plan.
True when the subject has no entry in transactions-params.
Fixed message accompanying notAvailable or notConfigured sentinel responses.
Example:Transaction Not Configured
TransactionEligibilitySectionResult
objectOne child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
Structured reason for a non-passing, warned, or indeterminate section.
Show Child Parameters
TransactionEligibilityRestrictionSectionResult
objectRestriction section of a per-subject result. status values: NOT_RESTRICTED, SOFT_RESTRICTED, HARD_RESTRICTED, COULD_NOT_DETERMINE. The access array lists all configured blocking restrictions for the transaction; it is present on restriction sections and omitted from policy/user sections.
Allowed values:NOT_RESTRICTEDSOFT_RESTRICTEDHARD_RESTRICTEDCOULD_NOT_DETERMINE
Example:NOT_RESTRICTED
Structured reason for a non-passing, warned, or indeterminate section.
Show Child Parameters
One entry in the access list of the restriction section.
Show Child Parameters
TransactionEligibilityReason
objectStructured reason for a non-passing, warned, or indeterminate section.
Example:RESTRICTED_DIVORCE
Example:Transaction is blocked by active restriction: DIVORCE
RestrictionAccessEntry
objectOne entry in the access list of the restriction section.
Restriction alert type code.
Example:DIVORCE
Restriction severity level for this alert type.
Example:HARD_RESTRICTION