planCodestringrequired
policyNumberstringrequired
Eligibility Check For Non-Forfeiture Transaction
post
Path 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/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
Zahara BPM Health Check
Returns the health status of the application
get
Response
application/json
Response
application/json
Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
get/bpm/actuator/health
application/json