Search
K
Policy Transactions

EmailDetail

object
emailIdstring

Example:1

startDatestring(date)

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

Example:2026-05-13

endDatestring(date)

Date (with pattern “yyyy-mm-dd”). Omit or send JSON null when not applicable.

emailTypestring

Allowed values:PERSONALWORKBUSINESSCUSTOMERSERVICEOTHER

Example:PERSONAL

emailAddressstring(email)

Type of the email. PERSONAL for personal emails, BUSINESS for business emails, CUSTOMERSERVICE for customer service emails, OTHER for any other type of emails.

Example:informant@example.com

isPreferredboolean

Example:true

Example

DeathNotification

object
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

Example

DeathClaimDocument

object
documentTypestring

Type of the supporting document.

Example:DEATH_CLAIM

documentNamestring

Human-readable name of the document.

Example:Certified Death Certificate - John Doe

edsDocumentIdstring

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

Example:EDS-DOC-20260617-001

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