Search
K
Policy Transactions

CaseEligibilitySectionResult

object

One 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

object

Eligibility 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

object

Policy 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

object

User 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

RestrictionEligibilitySectionResult

object

Restriction evaluation.

statusstring

Allowed values:NOT_RESTRICTEDRESTRICTEDSOFT_RESTRICTEDHARD_RESTRICTEDCOULD_NOT_DETERMINE

Example:NOT_RESTRICTED

blockTypestring

Blocking type from the restriction. Present on restriction section only.

Example:Unavailable

restrictionStatusarray[string]

Distinct blocking status values across all active restrictions for this subject. Present on the restriction section only when status=RESTRICTED.

Example:Unavailable, CarrierApprovalNeeded

reasonobject

Structured reason for a non-passing or indeterminate section.

Show Child Parameters
Example