EligibilitySubjectResult
objectEligibility result for one evaluated item. Fields that do not apply are omitted.
Identifier of the evaluated item.
Example:FullSurrender
True when every applicable eligibility check passes.
A transaction affected by a restriction type, with its blocking status.
Show Child Parameters
Policy eligibility evaluation.
Show Child Parameters
User permission evaluation.
Show Child Parameters
Restriction evaluation.
Show Child Parameters
True when the requested item is not available.
True when the requested item is not configured.
Explanation when an item is unavailable or not configured.
Example:Transaction Not Configured
PolicyEligibilitySectionResult
objectPolicy eligibility evaluation.
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
UserEligibilitySectionResult
objectUser permission evaluation.
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
Distinct access levels granted to the caller for this subject. Present when permissions are known; its presence does not override the status.
Allowed values:VIEWWRITEDELETE
Example:VIEW, WRITE
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
RestrictionEligibilitySectionResult
objectRestriction evaluation.
Allowed values:NOT_RESTRICTEDRESTRICTEDSOFT_RESTRICTEDHARD_RESTRICTEDCOULD_NOT_DETERMINE
Example:NOT_RESTRICTED
Blocking type from the restriction. Present on restriction section only.
Example:Unavailable
Distinct blocking status values across all active restrictions for this subject. Present on the restriction section only when status=RESTRICTED.
Example:Unavailable, CarrierApprovalNeeded
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
EligibilityReason
objectStructured reason for a non-passing or indeterminate section.
Machine-readable reason code.
Example:INSUFFICIENT_PERMISSIONS
Human-readable explanation.
Example:Caller does not hold the required permissions for this transaction
Validation error text. Used by rule-validation reasons.
Example:The effective date entered is not within this policy's free look period.
Suggested remediation. Used by rule-validation reasons.
Example:Update the effective date (if possible), or submit for NIGO processing.