EligibilityRequest
objectOptional request body shared by all four eligibility endpoints. planCode and policyNumber are supplied as path parameters, not in the body.
Subject identifiers to evaluate. Semantics depend on the endpoint: transaction/cancellation — transaction type codes (e.g. FullSurrender); capabilities — capability codes (e.g. ViewPolicy); restrictions — restriction type codes (e.g. DIVORCE, OVERPAYMENT). When absent or empty, all subjects configured for the plan are evaluated.
Example:FullSurrender, PartialWithdrawalOneTime
EligibilityResponse
objectTop-level eligibility response envelope. Shared by all four endpoints.
Echoes the eligibility type evaluated by the endpoint.
Allowed values:transactioncapabilitiesrestrictionscancellationsendFormDocuments
Example:transaction
Composed eligibility result for a single evaluated subject. Null fields are omitted from the JSON response (@JsonInclude NON_NULL). Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Show Child Parameters
EligibilitySubjectResult
objectComposed eligibility result for a single evaluated subject. Null fields are omitted from the JSON response (@JsonInclude NON_NULL). Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Subject identifier evaluated (transaction type, capability code, or restriction type code).
Example:FullSurrender
true only when policyEligibility=ELIGIBLE AND userEligibility=ELIGIBLE AND restriction is not RESTRICTED/HARD_RESTRICTED. SOFT_RESTRICTED does not fail eligibility. Any COULD_NOT_DETERMINE section forces eligible=false.
A transaction affected by a restriction type, with its blocking status.
Show Child Parameters
One 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
Show Child Parameters
One 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
Show Child Parameters
One 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
Show Child Parameters
True when the subject is absent from product-transactions for this plan.
True when the subject has no entry in transactions-params.
Human-readable explanation accompanying notAvailable or notConfigured.
Example:Transaction Not Configured
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