Search
K
Policy Transactions

EDelivery Enrollment

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json
idstring

preferenceId (should be null for preference creation)

Example:e22cd4aee27d34c9b7c748d50e558b41

carrierIdstringrequired

carrier id for policy

Example:CARRIERID_1

deliveryOptionstringrequired

Delivery Options - Applicable values EMAIL/FAX/MAIL

Allowed values:EMAILFAXMAIL

Example:EMAIL

emailstring

User’s email

Example:abc.def@gmail.com

effectiveFromstring(date-time)required

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will be effective, default value is ‘2999-12-31T00:00:00.000Z’

effectiveTostring(date-time)

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will stop being effective

documentTypestringrequired

Type of document

Allowed values:NWBANSTCONFTAXAGNTPOLPG

Example:AGNT

partyIdstringrequired

Unique reference id of the party

Example:f22de4bff27e45d9a7c859e61f668c50

acknowledgedByPartyIdstringrequired

Party that initiated the acknowledgment (i.e. an agent, if not the party referred to by partyId)

Example:f22de4bff27e45d9a7c859e61f668c50

Response

application/json

Success

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/policy/v1/transactions/{planCode}/{policyNumber}/edeliveryenrollment

Body

{ "carrierId": "CARRIERID_1", "deliveryOption": "EMAIL", "effectiveFrom": "effectiveFrom", "documentType": "AGNT", "partyId": "f22de4bff27e45d9a7c859e61f668c50", "acknowledgedByPartyId": "f22de4bff27e45d9a7c859e61f668c50" }
 
application/json

Policy - Transactions

All Apis related to policy operations

Create case for transaction

This operation must be invoked before submitting a transaction request. The service is responsible for creating a new case record, which becomes the prerequisite reference for all subsequent transaction activities.

post

Body

application/json

CreateCaseRequest

planCodestringrequired

Product code provided by the Zinnia system

Example:ABC001

policyNumberstring

In case of Post Issue Policy Number will be mandatory

Example:EVGL1234567

correlationIdstring

The correlationId associated with the case.

Example:218d8992-3783-42ac-b59a-66cbc36adaab

caseTypestringrequired

The type associated with the case.

Allowed values:ReinstatementNew Business

Example:Reinstatement

caseSubTypestringrequired

The type associated with the case.

Allowed values:ReinstatementLife Application

Example:Reinstatement

identifiersarray[object]required

An object representing an identifier and its corresponding value.

Show Child Parameters

Response

application/json

Case Created

CaseSuccessResponse

caseIdstring

Example:CA000000536

correlationIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

eappIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

policyNumberstring

Example:ABC37457845

post/policy/v1/transactions/case

Body

{ "planCode": "ABC001", "caseType": "Reinstatement", "caseSubType": "Reinstatement", "identifiers": [ {} ] }
 
application/json

Cancel a case

Cancels an existing case based on eligibility rules. The API validates that the case exists and that the associated BPM process has not yet started. If eligible, the case is transitioned to a CANCELLED status, cancellation metadata is persisted, and a NES cancellation event is emitted. Only cases in NOT_STARTED BPM state can be cancelled.

put

Path Parameters

caseIdstringrequired

The unique identifier of the case to cancel

Example:CA0000007516

Body

application/json

CaseCancellationRequest

correlationIdstringrequired

Unique identifier to trace the request across systems

Example:218d8992-3783-42ac-b59a-66cbc36adaa2

policyNumberstringrequired

The policy number associated with the case

Example:FIUL463340020

reasonstringrequired

The reason for cancelling the case

Example:User requested cancellation

requestedBystring

The entity requesting cancellation. Derived from the authenticated token.

Example:CLIENT

typestringrequired

The transaction type associated with the case

Example:Reinstatement

subTypestring

The transaction sub-type associated with the case

Example:Reinstatement

Response

application/json

Cancellation accepted and BPM process triggered

CaseCancellationResponse

caseIdstring

The unique identifier of the cancelled case

Example:CA0000007516

correlationIdstring

Unique identifier to trace the request across systems

Example:218d8992-3783-42ac-b59a-66cbc36adaa2

caseStatusstring

The updated status of the case

Example:CANCELLED

messagestring

Confirmation message

Example:Case cancellation initiated successfully

put/policy/v1/cases/{caseId}/cancel

Body

{ "correlationId": "218d8992-3783-42ac-b59a-66cbc36adaa2", "policyNumber": "FIUL463340020", "reason": "User requested cancellation", "requestedBy": "CLIENT", "type": "Reinstatement", "subType": "Reinstatement" }
 
application/json

Systematic Program Quote Request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

SystematicProgramQuoteRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

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

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

arrangementIdstring

The unique ID for the systematic programs available in the policy

Example:arr_1

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/quote

Body

{ "effectiveDate": "effectiveDate", "systematicProgram": { "paymentForm": "DTCC", "arrangementType": "PAYMENT" } }
 
application/json