Search
K
Policy Transactions

Eligibility Check Email Address Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

Email Address Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/emailaddress/eligibilitycheck
 
application/json

Add new Email Address based on request

Validates email address change requests for policy parties including ADD, UPDATE, and DELETE operations

post

Query Parameters

operationstringrequired

validate business rule for provided operation

Allowed values:ADDUPDATEDELETE

Example:ADD

bankIdstring

bank id

Example:1

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

Body

application/json

EmailChangeRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

emailobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA00000022023

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Response

application/json

Request accepted successfully and is being processed.

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

post/bpm/v1/policies/{planCode}/{policyNumber}/emailaddress/{partyId}/validation

Body

{ "effectiveDate": "effectiveDate", "email": { "startDate": "startDate", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com" } }
 
application/json

Eligibility Check Communication Preference Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

Communication Preference Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/communicationpreference/eligibilitycheck
 
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