Search
K
Policy Transactions

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

Get supported configurations for a transaction

get

Query Parameters

transactionstring
arrangementTypestring

Path Parameters

clientCodestringrequired
planCodestringrequired
transactionNamestringrequired

Allowed values:SystematicProgramSetupSystematicProgramUpdate

Response

application/json

Success response

get/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/paymentforms
 
application/json

Get supported configurations for a transaction

get

Query Parameters

transactionstring
arrangementTypestring

Path Parameters

clientCodestringrequired
planCodestringrequired
transactionNamestringrequired

Allowed values:SystematicProgramSetupSystematicProgramUpdate

Response

application/json

Success response

get/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/prevalidationreference
 
application/json

Get eligible transaction types for a policy by CUSIP and policy number

Returns the list of eligible transaction types for the given CUSIP and policy number.

get

Path Parameters

cusipstringrequired

CUSIP number

policyNumberstringrequired

Policy number

Response

application/json

Success

EligibleTransactionsResponse

cusipstring

Example:123456789

productCodestring

Example:ADDAARP

eligibleTransactionTypesarray[object]

List of eligible transaction types

Show Child Parameters
get/bpm/v1/policies/{cusip}/{policyNumber}/eligibleTransactions
 
application/json