planCodestringrequired
policyNumberstringrequired
Set Delivery Date Transaction
post
Path Parameters
Body
application/json
Body
application/json
SetDeliveryDateRequest
correlationIdstring
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
taxIdstring
Example:666911019
documentTypestring
Example:POLPG
acknowledgementDatestring(date-time)
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Response
application/json
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/bpm/v1/policies/{planCode}/{policyNumber}/deliverydatesetup
Path Parameters
Body
{}
application/json
EDelivery Enrollment
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
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/bpm/v1/policies/{planCode}/{policyNumber}/edeliveryenrollment
Path Parameters
Body
{
"carrierId": "CARRIERID_1",
"deliveryOption": "EMAIL",
"effectiveFrom": "effectiveFrom",
"documentType": "AGNT",
"partyId": "f22de4bff27e45d9a7c859e61f668c50",
"acknowledgedByPartyId": "f22de4bff27e45d9a7c859e61f668c50"
}
application/json
Eligibility Check For Initial Premium
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/initialpremium/eligibilitycheck
Path Parameters
application/json
Validation Check For Initial Premium
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
InitialPremiumRequest
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
effectiveDatestring(date)
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
transactionReasonstring
Optional Reason for this transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICE
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
exchangeobject
Show Child Parameters
taxBasisobject
Show Child Parameters
payorobject
Show Child Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/initialpremium/validation
Path Parameters
Body
{}
application/json
Initial Premium Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
InitialPremiumRequest
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
effectiveDatestring(date)
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
transactionReasonstring
Optional Reason for this transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICE
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
exchangeobject
Show Child Parameters
taxBasisobject
Show Child Parameters
payorobject
Show Child Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/initialpremium
Path Parameters
Body
{}
application/json