Policy Transactions
CaseEligibilitySubjectResult
objectComposed eligibility result for a single case feature. Null fields are omitted from the JSON response. Evaluated results include the configured check sections; unavailable or unmapped features include notAvailable/notConfigured metadata.
eligibilityItemstringrequired
Case feature identifier evaluated.
Example:cancelTransaction
eligiblebooleanrequired
true only when every enabled blocking check for this feature returns PASSED. FAILED or COULD_NOT_DETERMINE on any enabled blocking check forces eligible=false.
caseStatusEligibilityobject
One case eligibility check result section.
Show Child Parameters
carrierEligibilityobject
One case eligibility check result section.
Show Child Parameters
userEligibilityobject
One case eligibility check result section.
Show Child Parameters
zaharaTransactionEligibilityobject
One case eligibility check result section.
Show Child Parameters
checkResultsobject
Map of all configured check results keyed by check name.
Example:{"CASE_STATUS":{"status":"PASSED"},"CARRIER_ONBOARDED":{"status":"PASSED"},"USER_PERMISSION":{"status":"PASSED"},"ZAHARA_TRANSACTION_STATUS":{"status":"PASSED"}}
notAvailableboolean
True when the requested feature is not enabled for the resolved case transaction.
notConfiguredboolean
True when the case cannot be mapped to a configured transaction.
messagestring
Human-readable explanation accompanying notAvailable or notConfigured.
Example:Feature Not Available
Example
CaseEligibilitySectionResult
objectOne case eligibility check result section.
statusstring
Allowed values:PASSEDFAILEDSKIPPEDCOULD_NOT_DETERMINE
Example:PASSED
reasonobject
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
Example
EligibilitySubjectResult
objectEligibility result for one evaluated item. Fields that do not apply are omitted.
eligibilityItemstringrequired
Identifier of the evaluated item.
Example:FullSurrender
eligiblebooleanrequired
True when every applicable eligibility check passes.
restrictedTransactionsarray[object]
A transaction affected by a restriction type, with its blocking status.
Show Child Parameters
policyEligibilityobject
Policy eligibility evaluation.
Show Child Parameters
userEligibilityobject
User permission evaluation.
Show Child Parameters
restrictionobject
Restriction evaluation.
Show Child Parameters
notAvailableboolean
True when the requested item is not available.
notConfiguredboolean
True when the requested item is not configured.
messagestring
Explanation when an item is unavailable or not configured.
Example:Transaction Not Configured
Example
PolicyEligibilitySectionResult
objectPolicy eligibility evaluation.
statusstring
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
reasonobject
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
reasonsarray[object]
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
Example
UserEligibilitySectionResult
objectUser permission evaluation.
statusstring
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
accessarray[string]
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
reasonobject
Structured reason for a non-passing or indeterminate section.
Show Child Parameters
Example