planCodestringrequired
policyNumberstringrequired
EDelivery Enrollment
post
Path Parameters
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
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/edeliveryenrollment
Authentication
Path Parameters
Body
[
{
"carrierId": "CARRIERID_1",
"deliveryOption": "EMAIL",
"effectiveFrom": "effectiveFrom",
"documentType": "AGNT",
"partyId": "f22de4bff27e45d9a7c859e61f668c50",
"acknowledgedByPartyId": "f22de4bff27e45d9a7c859e61f668c50"
}
]
application/json
Eligibility Check For Non-Forfeiture Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture/eligibilitycheck
Authentication
Path Parameters
application/json
Validation Check For Non-Forfeiture Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
Nonforfeiture
planCodestring
planCode (may duplicate path parameter)
Example:string
policyNumberstring
policyNumber (may duplicate path parameter)
Example:string
correlationIdstring
Example:string
carrierIdstring
Example:string
policyFeaturesarray[object]
Show Child Parameters
signaturesarray[object]
Show Child Parameters
documentsarray[object]
Show Child Parameters
supportingDocumentAttachedboolean
Example:true
partiesarray[object]
Show Child Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture/validation
Authentication
Path Parameters
Body
{}
application/json
Non-Forfeiture Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
Nonforfeiture
planCodestring
planCode (may duplicate path parameter)
Example:string
policyNumberstring
policyNumber (may duplicate path parameter)
Example:string
correlationIdstring
Example:string
carrierIdstring
Example:string
policyFeaturesarray[object]
Show Child Parameters
signaturesarray[object]
Show Child Parameters
documentsarray[object]
Show Child Parameters
supportingDocumentAttachedboolean
Example:true
partiesarray[object]
Show Child Parameters
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
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/nonforfeiture
Authentication
Path Parameters
Body
{}
application/json
Policy - Transactions
All Apis related to policy operations