EligibilityRequest
objectOptional request body. Plan code and policy number are supplied in the path.
Item identifiers to evaluate. When omitted or empty, all available items are evaluated.
Example:FullSurrender, PartialWithdrawalOneTime
EligibilityResponse
objectEligibility evaluation response.
Eligibility category evaluated.
Allowed values:transactioncapabilitiesrestrictionscancellationsendFormDocuments
Example:transaction
Eligibility result for one evaluated item. Fields that do not apply are omitted.
Show Child Parameters
CaseEligibilityRequest
objectOptional request body for case-level eligibility. The caller supplies only caseId in the path; policy and transaction context are resolved from Case Management. When items is absent or empty, all configured case features are evaluated.
Case feature identifiers to evaluate.
Example:cancelTransaction
CaseEligibilityResponse
objectTop-level case eligibility response envelope.
Case eligibility response type.
Allowed values:case
Example:case
Case identifier evaluated.
Example:CA0001552404
Carrier code resolved from Case Management.
Example:EVGL
Process key resolved from Case Management.
Example:Withdrawal
Process subtype key resolved from Case Management.
Example:Full Surrender
Transaction type resolved from case process mapping.
Example:FullSurrender
Composed 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.
Show Child Parameters
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.
Case feature identifier evaluated.
Example:cancelTransaction
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.
One case eligibility check result section.
Show Child Parameters
One case eligibility check result section.
Show Child Parameters
One case eligibility check result section.
Show Child Parameters
One case eligibility check result section.
Show Child Parameters
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"}}
True when the requested feature is not enabled for the resolved case transaction.
True when the case cannot be mapped to a configured transaction.
Human-readable explanation accompanying notAvailable or notConfigured.
Example:Feature Not Available