Search
K
Policy Transactions

Transactions Eligibility

Eligibility evaluation for different operations

Transaction eligibility

Evaluates whether the authenticated user may perform specific transactions on the
given policy. Runs three checks: product level eligibility, user permissions
, and policy restrictions restrictions.

If items is omitted or empty, all transactions configured for the plan are evaluated.
partyId is extracted from the Authorization bearer token — it is never a body field.

post

Path Parameters

planCodestringrequired

Plan code (exact, case-sensitive).

Example:ANN100

policyNumberstringrequired

Policy number (exact, case-sensitive).

Example:POL123456

Body

application/json

EligibilityRequest

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

Response

application/json

Eligibility evaluation completed. One result entry per evaluated subject.

EligibilityResponse

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
post/policy/v2/transactions/{planCode}/{policyNumber}/eligibility/transaction

Body

{ "items": [ "FullSurrender", "PartialWithdrawalOneTime" ] }
 
application/json

Case eligibility

Evaluates whether the authenticated user may perform configured case-level features
for the given case. The caller supplies only caseId; policy number, plan code,
carrier, process, process subtype, and case correlationId are resolved from Case
Management.

The service maps the case process/processSubType to a transaction type, resolves
enabled features from feature configuration, and evaluates configured checks such as
case status, carrier onboarding, user permission, and Zahara transaction status.

Zahara transaction status is matched by the case correlationId against the list of
Zahara transactions returned for the case policy’s plan code and policy number.

If items is omitted or empty, all features configured for the resolved
carrier/plan/transaction are evaluated. partyId is extracted from the
Authorization bearer token; it is never a body field.

post

Path Parameters

caseIdstringrequired

Case identifier.

Example:CA0001552404

Body

application/json

CaseEligibilityRequest

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

Response

application/json

Case eligibility evaluation completed. One result entry per evaluated case feature.

CaseEligibilityResponse

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
post/case/v1/cases/{caseId}/eligibility

Body

{ "items": [ "cancelTransaction" ] }
 
application/json

Receives policyholder authorization status from MPV and updates the status

put

Path Parameters

planCodestringrequired

The plan code for the policy number

Example:planCode

policyNumberstringrequired

Policy Number

Example:policyNumber

Body

application/json

Policyholder Authorization request

AuthorizationStatusRequest

recordIdstringrequired

Unique record ID (maps to transactionID)

Example:546bed32-a8b6-43dc-8772-cefb1d469b1d

correlationIdstringrequired

Correlation ID linking BPM - MPV transaction

Example:468cd184-fb43-4a20-aa8c-23df99c0a353

caseIdstringrequired

Case identifier within BPM

Example:CA0000487609

policyNumberstringrequired

Policy Number associated with the transaction

Example:FM00000001

authorizationStatusstringrequired

Policy Holder Authorization Status

Allowed values:APPROVEDDENIED

Example:APPROVED

actionTakenBystring

Name of Policy Holder

Example:Flora Anderson

actionTimestampstring(date-time)required

Generated at Time

Example:2025-06-02T10:45:00Z

sourcestring

Source system sending the callback

Default:MPV

Example:My Policy View

Response

application/json

OK - Callback processed successfully

AuthorizationStatusResponse

statusinteger

Example:200

put/bpm/v1/policies/{planCode}/{policyNumber}/authorization/status

Body

{ "recordId": "546bed32-a8b6-43dc-8772-cefb1d469b1d", "correlationId": "468cd184-fb43-4a20-aa8c-23df99c0a353", "caseId": "CA0000487609", "policyNumber": "FM00000001", "authorizationStatus": "APPROVED", "actionTimestamp": "2025-06-02T10:45:00Z" }
 
application/json

Secure API to get TransactionData by transactionId

get

Path Parameters

transactionIdstringrequired

Response

application/json

Transaction Model success

TransactionModelResponse

Model for a transaction with detailed information.

recordIdstring

Unique identifier for the transaction record.

correlationIdstring

Correlation ID associated with the transaction.

transactionTypestring

Type of transaction.

carrierstring

Carrier associated with the transaction.

sourcestring

Source of the transaction.

entityTypestring

Type of the entity involved.

entityIdstring

Unique identifier for the entity.

entityobject

Actual entity information as JSON Object.

expireTsstring(date-time)

Expiration timestamp for the transaction.

createdTsstring(date-time)

Timestamp when the transaction was created.

updatedTsstring(date-time)

Timestamp when the transaction was last updated.

createdBystring

User or system that created the transaction.

updatedBystring

User or system that last updated the transaction.

identifiersarray[object]

Identifier model with key-value pair.

Show Child Parameters
get/bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}
 
application/json