RestrictionSubTypeRecord
objectAn individual sub-type within a restriction type.
Sub-type identifier/label.
Example:No info released
Example:This policy/contract is under a legal hold.
TransactionEligibilityRequest
objectOptional request body for path-based transaction eligibility. planCode and policyNumber are supplied as path parameters, not in the body.
Transaction type identifiers to evaluate. When absent or empty, all transactions configured for the plan in product-transactions reference data are evaluated.
Example:FullSurrender, PartialWithdrawalOneTime
TransactionEligibilityResponse
objectTop-level transaction eligibility response envelope.
Eligibility type evaluated. Always transaction for this endpoint.
Example:transaction
Composed eligibility result for a single transaction subject. Null fields are omitted from the JSON response. Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Show Child Parameters
TransactionEligibilitySubjectResult
objectComposed eligibility result for a single transaction subject. Null fields are omitted from the JSON response. Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Transaction type identifier evaluated.
Example:FullSurrender
Overall eligibility. true only when policy and user sections are ELIGIBLE and restriction is not HARD_RESTRICTED.
One child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Show Child Parameters
One child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Show Child Parameters
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.
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.
Fixed message accompanying notAvailable or notConfigured sentinel responses.
Example:Transaction Not Configured
TransactionEligibilitySectionResult
objectOne child section of a per-subject result (policy or user eligibility). status values: ELIGIBLE, NOT_ELIGIBLE, COULD_NOT_DETERMINE.
Allowed values:ELIGIBLENOT_ELIGIBLECOULD_NOT_DETERMINE
Example:ELIGIBLE
Structured reason for a non-passing, warned, or indeterminate section.