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.
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. 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.