Policy Transactions
Initial Death Claim Eligibility Check
Checks whether an initial death claim can be submitted for the given policy.
No request body is required; eligibility is derived from the policy identified
by planCode and policyNumber. An eligible policy returns status success; an
ineligible policy returns status failure with the reasons in error.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED022
Response
application/json
Response
application/json
Eligibility check completed successfully. The policy is eligible for an initial death claim.
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/initialdeathclaim/eligibilitycheck
Authentication
Path Parameters
application/json
Initial Death Claim Validation
Validates an initial death claim payload for the given policy without
submitting it. A payload that passes every check returns status success; a
payload that fails returns status failure with the reasons in error.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED022
Body
application/json
Body
application/json
InitialDeathClaimRequest
correlationIdstring
Unique identifier used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”) when the death claim transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2025-12-15
transactionReasonstringrequired
Reason for the transaction
Allowed values:DEATH_NOTIFICATION
Example:DEATH_NOTIFICATION
externalIdentifiersobject
Show Child Parameters
policyobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
deathNotificationobjectrequired
Show Child Parameters
documentsarray[object]
Supporting documents associated with the death claim (e.g. certified death certificate).
Show Child Parameters
riderClaimarray[object]
Rider claims applicable to the policy. Each entry links the elected rider to the party it applies to.
Show Child Parameters
Response
application/json
Response
application/json
Validation completed successfully. The payload is valid for submission.
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/initialdeathclaim/validation
Authentication
Path Parameters
Body
{
"effectiveDate": "2025-12-15",
"transactionReason": "DEATH_NOTIFICATION",
"parties": [
{
"partyId": "2f356dcc-303d-4fc0-94a2-5369fb62642a",
"partyRole": "PRIMARYBENEFICIARY",
"partyType": "INDIVIDUAL"
}
],
"deathNotification": {
"partyId": "2f4c4f6d-7b3e-4d0d-b9e8-8f3a4f0c2201",
"notificationReceivedDate": "2025-12-15",
"claimStatus": "PENDING",
"deathDetails": {}
}
}
application/json
Submit First Notice of Loss (FNOL)
Submits a First Notice of Loss notification for the given policy.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED022
Body
application/json
Body
application/json
FnolRequest
Request payload for POST /fnol. Reuses the same party/policy/death-notification
shapes as InitialDeathClaimRequest. Always creates an FNOL case; when the deceased
party (deathNotification) is the Insured or Annuitant, also attempts to create an
Initial Death Notification (IDN) case - unless one already exists for this policy
and deceased party (any status), or the policy status isn’t one of Active, Pending
Lapse, Payout, Lapse, in which case no IDN case is created.
correlationIdstring
Unique identifier used by every system to trace the request
Example:381ee1cc-7f34-47b1-a007-948d26b68a0f
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”) the FNOL is effective. Must not be later than
deathNotification.notificationReceivedDate (INVALID_EFFECTIVE_DATE), and must not
be earlier than deathNotification.deathDetails.dateOfDeath (INVALID_EFFECTIVE_DATE).
Example:2026-07-15
transactionReasonstringrequired
Reason for the transaction
Allowed values:DEATH_NOTIFICATION
Example:DEATH_NOTIFICATION
externalIdentifiersobjectrequired
Show Child Parameters
policyobjectrequired
Show Child Parameters
partiesarray[object]required
Must include exactly one party with isNotifier=true.
Show Child Parameters
deathNotificationobjectrequired
The deceased party. dateOfDeath must not be later than notificationReceivedDate
(INVALID_DATE_OF_DEATH).
Show Child Parameters
documentsarray[object]
Supporting documents associated with the FNOL (e.g. death certificate).
Show Child Parameters
riderClaimarray[object]
Rider claims applicable to the policy. Each entry links the elected rider to the party it applies to.
Show Child Parameters
Response
application/json
Response
application/json
Submit Transaction Successful
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}/fnol
Authentication
Path Parameters
Body
{
"effectiveDate": "2026-07-15",
"transactionReason": "DEATH_NOTIFICATION",
"externalIdentifiers": {},
"policy": {
"policyNumber": "POL-20251215-001",
"productType": "FIXEDINDEXEDANNUITY",
"lineOfBusiness": "LIFE"
},
"parties": [
{
"partyId": "2f356dcc-303d-4fc0-94a2-5369fb62642a",
"partyRole": "PRIMARYBENEFICIARY",
"partyType": "INDIVIDUAL"
}
],
"deathNotification": {
"partyId": "2f4c4f6d-7b3e-4d0d-b9e8-8f3a4f0c2201",
"notificationReceivedDate": "2025-12-15",
"claimStatus": "PENDING",
"deathDetails": {}
}
}
application/json
Submit Initial Death Claim Transaction
Submits an initial death claim notification for the given policy.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED022
Body
application/json
Body
application/json
InitialDeathClaimRequest
correlationIdstring
Unique identifier used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”) when the death claim transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2025-12-15
transactionReasonstringrequired
Reason for the transaction
Allowed values:DEATH_NOTIFICATION
Example:DEATH_NOTIFICATION
externalIdentifiersobject
Show Child Parameters
policyobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
deathNotificationobjectrequired
Show Child Parameters
documentsarray[object]
Supporting documents associated with the death claim (e.g. certified death certificate).
Show Child Parameters
riderClaimarray[object]
Rider claims applicable to the policy. Each entry links the elected rider to the party it applies to.
Show Child Parameters
Response
application/json
Response
application/json
Submit Transaction Successful
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}/initialdeathclaim
Authentication
Path Parameters
Body
{
"effectiveDate": "2025-12-15",
"transactionReason": "DEATH_NOTIFICATION",
"parties": [
{
"partyId": "2f356dcc-303d-4fc0-94a2-5369fb62642a",
"partyRole": "PRIMARYBENEFICIARY",
"partyType": "INDIVIDUAL"
}
],
"deathNotification": {
"partyId": "2f4c4f6d-7b3e-4d0d-b9e8-8f3a4f0c2201",
"notificationReceivedDate": "2025-12-15",
"claimStatus": "PENDING",
"deathDetails": {}
}
}
application/json
Validation OneTime Premium Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
OneTimePremiumRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
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
transactionAmountsobjectrequired
Show Child Parameters
payor
Any Ofrequired
Variant 1object
Show Child Parameters
transactionReasonstring
Reason for Initiating One Time Premium Transaction
Allowed values:ONETIMEPREMIUMPRODUCTDEFAULT
Example:PRODUCTDEFAULT
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
externalTransactionIdstring
Transaction ID from external system
Example:A12345
overrideboolean
BPM will have to override the rules if this variable is marked as ‘true’
Response
application/json
Response
application/json
OneTime Premium Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/validation
Authentication
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"transactionAmounts": {
"requestedAmount": 0
},
"payor": {
"bankId": "bankId"
}
}
application/json