Search
K
Policy Transactions

TransactionEligibilitySectionResult

object

One child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.

statusstring

Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE

Example:ELIGIBLE

reasonobject

Structured reason for a non-passing, warned, or indeterminate section.

Show Child Parameters
Example

TransactionEligibilityRestrictionSectionResult

object

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.

statusstring

Allowed values:NOT_RESTRICTEDSOFT_RESTRICTEDHARD_RESTRICTEDCOULD_NOT_DETERMINE

Example:NOT_RESTRICTED

reasonobject

Structured reason for a non-passing, warned, or indeterminate section.

Show Child Parameters
accessarray[object]

One entry in the access list of the restriction section.

Show Child Parameters
Example

TransactionEligibilityReason

object

Structured reason for a non-passing, warned, or indeterminate section.

codestring

Example:RESTRICTED_DIVORCE

messagestring

Example:Transaction is blocked by active restriction: DIVORCE

Example

RestrictionAccessEntry

object

One entry in the access list of the restriction section.

alertTypestring

Restriction alert type code.

Example:DIVORCE

restrictionLevelstring

Restriction severity level for this alert type.

Example:HARD_RESTRICTION

Example

TransactionEligibilityErrorResponse

object

Error envelope returned by eligibility endpoints on 4xx/5xx responses.

statusinteger

Example:401

errorstring

Example:Unauthorized

messagestring

Example:partyId claim could not be extracted

Example