ClaimParty

object

Beneficiary/party details used internally by notification-method update processing.

partyIdstring

Example:e6954b3d-a0ef-47dc-ac49-046db6bc7da7

partyRoleIdstring

Example:PR-10045

partyRolestring

Example:PRIMARYBENEFICIARY

partyTypestring

Example:INDIVIDUAL

trustTypestring

Example:INTERVIVOSTRUST

prefixstring

Example:Ms.

suffixstring

Example:Jr.

firstNamestring

Example:Jane

middleNamestring

Example:Marie

lastNamestring

Example:Smith

fullNamestring

Example:Jane Marie Smith

genderstring

Example:FEMALE

dateOfBirthstring(date)

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

Example:1990-01-01

dateOfDeathstring(date)

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

relationshipToInsuredstring

Example:SPOUSE

relationshipToPartystring

Example:SPOUSE

beneficiaryPartyTypestring

Example:PRIMARY

beneficiaryPercentagenumber(double)

Example:50

beneficiaryNetDeathBenefitnumber(double)

Example:100000

beneficiaryStatestring

Example:NJ

residenceStatestring

Example:NJ

ssnstring

Example:123-45-6789

phoneobject
Show Child Parameters
agentExternalIdstring

Example:AGT10001

taxIdentifierTypestring

Example:SSN

sorDistributionMethodobject
Show Child Parameters
formDistributionMethodobject
Show Child Parameters
actionstring

Allowed values:NONEUPDATEADDDELETE

Example:UPDATE

residentAddressobject
Show Child Parameters
identifiersarray[object]
Show Child Parameters
organizationCodestring

Example:ORG-10045

entityTypestring

Example:CORPORATION

trustTitlestring

Example:Trustee

trustDatestring(date)

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

Example:2025-12-15

trustNamestring

Example:The Smith Family Trust

governingStateOfTruststring

Example:NJ

enityTypestring

Mirrors the “entityType” field above; retained for backward compatibility with the source model.

Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONINSURANCECOMPANYUNKNOWN

Example:CORPORATION

Example

ClaimBeneChangeDetail

object
changeRequireboolean

Example:true

changeTypestring

Allowed values:BENEFICIARY_DECEASEDBENEFICIARY_NOTIFICATION_CHANGEBENEFICIARY_ADDRESS_CHANGE

Example:BENEFICIARY_NOTIFICATION_CHANGE

beneDeceasedboolean
beneDeathDatestring(date)

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

beneDeathSourceOfInfostring

Example:Death Master File

notificationPreferencesobject
Show Child Parameters
documentDataarray[object]

Document metadata associated with this change

Show Child Parameters
Example

ClaimNotificationPreferences

object
notificationMethodobject
Show Child Parameters
faxobject
Show Child Parameters
emailobject
Show Child Parameters
addressobject
Show Child Parameters
phoneobject
Show Child Parameters
Example

ClaimNotificationMethod

object
actionstring

Allowed values:NONEUPDATEADDDELETE

Example:UPDATE

methodstring

Allowed values:MAILEMAILFAXNUMBER

Example:EMAIL

faxOptedboolean
emailOptedboolean

Example:true

mailOptedboolean
Example

ClaimFax

object
actionstring

Allowed values:NONEUPDATEADDDELETE

Example:UPDATE

faxNumberstring

Example:973-555-0101

Example