Search
K
Policy Transactions

TransactionAttributeRecord

object

A single resolved attribute entry. Always contains only the final resolved value — override configuration is never included in the response.

attributeNamestringrequired

Attribute identifier.

Example:sendPaymentToBrokrageAccount

attributeTypestringrequired

Data type of the attribute value.

Allowed values:STRINGBOOLEANNUMBERLIST

Example:BOOLEAN

itemTypestring

Required when attributeType is LIST (e.g. “STRING”); null for all other types.

Example:STRING

attributeValuerequired

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

Example

EligibilityRequest

object

Optional request body. Plan code and policy number are supplied in the path.

itemsarray[string]

Item identifiers to evaluate. When omitted or empty, all available items are evaluated.

Example:FullSurrender, PartialWithdrawalOneTime

Example

EligibilityResponse

object

Eligibility evaluation response.

eligibilityTypestringrequired

Eligibility category evaluated.

Allowed values:transactioncapabilitiesrestrictionscancellationsendFormDocuments

Example:transaction

resultsarray[object]required

Eligibility result for one evaluated item. Fields that do not apply are omitted.

Show Child Parameters
Example

CaseEligibilityRequest

object

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

itemsarray[string]

Case feature identifiers to evaluate.

Example:cancelTransaction

Example

CaseEligibilityResponse

object

Top-level case eligibility response envelope.

eligibilityTypestringrequired

Case eligibility response type.

Allowed values:case

Example:case

caseIdstringrequired

Case identifier evaluated.

Example:CA0001552404

carrierCodestring

Carrier code resolved from Case Management.

Example:EVGL

processTypeKeystring

Process key resolved from Case Management.

Example:Withdrawal

processSubTypeKeystring

Process subtype key resolved from Case Management.

Example:Full Surrender

transactionTypestring

Transaction type resolved from case process mapping.

Example:FullSurrender

resultsarray[object]required

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
Example