EligibilitySectionResult
objectOne evaluation section of a per-subject result (policyEligibility, userEligibility, or restriction).
policyEligibility status: ELIGIBLE | NOT_ELIGIBLE | COULD_NOT_DETERMINE
userEligibility status: ELIGIBLE | NOT_ELIGIBLE | COULD_NOT_DETERMINE
restriction status: NOT_RESTRICTED | RESTRICTED | SOFT_RESTRICTED | HARD_RESTRICTED | COULD_NOT_DETERMINE
Allowed values:ELIGIBLENOT_ELIGIBLENOT_RESTRICTEDRESTRICTEDSOFT_RESTRICTEDHARD_RESTRICTEDCOULD_NOT_DETERMINE
Example:ELIGIBLE
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
Distinct access levels granted to the caller for this subject, derived from the permissions the caller actually holds. Present on userEligibility only when status=ELIGIBLE. The calling system decides how to act on this list.
Allowed values:VIEWWRITEDELETE
Example:VIEW, WRITE
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
RestrictedTransactionResult
objectA transaction affected by a restriction type, with its blocking status.
Transaction type code.
Example:FullSurrender
How the transaction is blocked (e.g. Unavailable, CarrierApprovalNeeded).
Example:Unavailable
EligibilityErrorResponse
objectError envelope returned by eligibility endpoints on 4xx/5xx responses.
Example:401
Example:Unauthorized
Example:partyId claim could not be extracted
IdentifierInstance
objectAn object representing an identifier and its corresponding value.
The type of identifier.
Allowed values:eAppIdpolicyNumber
The value of the identifier.
Example:ABC123349257367