TransactionAttributesResponse
objectResponse for GET /policy/v1/transactions/{planCode}/{policyNumber}/transaction-attributes/{transactionType}. Always returns HTTP 200. Check found to determine whether configuration exists. Attributes are merged from ref-transaction-attributes (plan-specific) and ref-transaction-attributes-default (client-level defaults); specific takes precedence on collision.
true when at least one collection returned a record and attributes were resolved; false otherwise.
Example:true
Human-readable explanation when found is false. Absent when found is true.
Example:No attribute configuration found for transactionType=Nonforfeiture, clientCode=GILI, planCode=GCFIA901
Carrier code derived from the policy. Null when the policy could not be fetched.
Example:GILI
Plan code from the request path.
Example:GCFIA901
Policy number from the request path.
Example:9013055733
Transaction type from the request path.
Example:OneTimeWithdrawal
A single resolved attribute entry. Always contains only the final resolved value — override configuration is never included in the response.
Show Child Parameters
TransactionAttributeRecord
objectA single resolved attribute entry. Always contains only the final resolved value — override configuration is never included in the response.
Attribute identifier.
Example:sendPaymentToBrokrageAccount
Data type of the attribute value.
Allowed values:STRINGBOOLEANNUMBERLIST
Example:BOOLEAN
Required when attributeType is LIST (e.g. “STRING”); null for all other types.
Example:STRING
The resolved value. Type corresponds to attributeType — Boolean, String, Number, or array of itemType for LIST. For derived attributes this reflects the matched override value, or the configured default when no override matched.
Example:true
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