Search
K
Policy Transactions

DeathNotification

object
partyIdstringrequired

Identifier of the deceased party. Must match the partyId of one of the parties in the request.

Example:2f4c4f6d-7b3e-4d0d-b9e8-8f3a4f0c2201

partyRolestring

Role held by the deceased party on the policy.

Allowed values:INSUREDOWNERJOINTOWNERPRIMARYBENEFICIARYANNUITANTCOVEREDINSURED

Example:INSURED

notificationReceivedDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Example:2025-12-15

proofOfDeathReceivedboolean
certifiedReceivedDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Example:2025-12-15

claimStatusstringrequired

Allowed values:PENDINGAPPROVEDDENIEDIN_PROGRESS

Example:PENDING

deathDetailsobjectrequired
Show Child Parameters
Example

DeathDetails

object
dateOfDeathstring(date)

Date (with pattern “yyyy-mm-dd”)

Example:2025-12-15

locationOfDeathstring

Example:Newark, NJ

countryOfDeathstring

Abbreviated names for countries

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAYEOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCWCGMCVASZPSJEIMRSMEHM

causeOfDeathstring

Manner or cause of the death, when known.

Allowed values:NATURALDEATHACCIDENTSUICIDEHOMICIDEPENDINGINVESTIGATIONUNKNOWN

Example:NATURALDEATH

Example

DeathClaimDocument

object
documentTypestring

Type of the supporting document.

Example:DEATH_CERTIFICATE

documentNamestring

Human-readable name of the document.

Example:Certified Death Certificate - John Smith

documentIdstring

Identifier of the document in the Enterprise Document Store (EDS).

Example:EDS-DOC-987654321

Example

DeathClaimRiderClaim

object
riderCodestring

Code identifying the rider on the policy.

Example:CHILD_TERM

riderNamestring

Display name of the rider.

Example:Child Term Rider

riderElectedboolean

Whether the rider was elected on the policy.

Example:true

partyIdstring

Identifier of the party the rider claim applies to. Must match the partyId of one of the parties in the request.

Example:4a2d8c01-9a1d-4f35-8f0b-3e6d3b7d3301

Example

Outgoingfundtransfer

object
planCodestring

Example:TEST8

correlationIdstring

Example:oft-corr-001

partyIdstring

Example:owner-party-id-001

policyNumberstring

Example:112132141

businessKeystring

Example:case-12345

transactionNamestring

Example:OutgoingFundTransfer

deleteRequestboolean
requestTypestring

Example:ADD

submitInfoobject
Show Child Parameters
receivedDatestring(date-time)

Example:2026-06-01T10:00:00Z

carrierIdstring

Example:SBGC

caseIdstring

Example:case-12345

effectiveDatestring(date)

Example:2026-06-01

reverseInitiatorboolean
replacementIndicatorboolean

Example:true

typestring

Example:FULLSURRENDER

externalIdentifiersobject
Show Child Parameters
transactionEffectiveOnobject
Show Child Parameters
exchangeInformationobject
Show Child Parameters
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
authorizationDetailsobject
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
documentsarray[object]
Show Child Parameters
loaTransferValidationobject
Show Child Parameters
selfServeFlowboolean

Example:true

supportingDocumentAttachedboolean

Example:true

isSignValidationRequiredboolean
paperboolean
ownerSignStatusstring

Example:VALID

jointOwnerRoleExistsboolean

Example:true

jointOwnerSignStatusstring

Example:VALID

signaturesarray[object]
Show Child Parameters
Example