PartyRoleChangeEmail

object
emailIdstring
startDatestring(date)
endDatestring(date)
emailTypestring
emailAddressstring
preferredEmailIndicatorstring
isPreferredboolean
Example

PartyRoleChangeBankDetails

object

Bank details associated with a party

bankIdstring
appliesToPartyIdstring
startDatestring(date)
endDatestring(date)
nameOnAccountstring
accountStatusstring
accountTypestring
accountSubTypestring
accountNumberstring
routingNumberstring
internationalBankAccountNumberstring
branchNamestring
branchAddressobject
Show Child Parameters
branchPhoneNumberstring
bankAccountPurposestring
Example

PartyRoleChangeDeathDetails

object
dateOfDeathstring(date)
causeOfDeathstring
deathNotificationDatestring(date)
dateOfDueProofstring(date)
Example

PartyRoleChangeImpairmentDetails

object
disabledboolean
disabilityStartDatestring(date)
Example

PartyDetailsForPartyRole

object

Full party detail payload (pa-bpm-txn-common PartyDetailsForPartyRoleDto).
Only the fields relevant to the action/party role need to be populated.

startDatestring(date)
endDatestring(date)
timestampstring
customerIdstring
partyIdstring

Party identifier. Required for UPDATE/DELETE actions; omit (or leave
null) for ADD so the carrier assigns one. Defaults to a random UUID
client-side if not explicitly set - always set explicitly for
UPDATE/DELETE.

parentPartyIdstring

Parent party identifier (e.g. for a minor’s guardian relationship)

partyTypestring
partyStatusstring
beneficiaryPercentageinteger
firstNamestring
middleNamestring
lastNamestring
fullNamestring
prefixstring
suffixstring
genderstring
genderIdentitystring
dateOfBirthstring(date)
attainedAgeinteger
birthCountrystring
citizenCountrystring
birthStatestring
doingBusinessAsstring
abbreviatedNamestring
organizationCodestring
entityTypestring
trustDatestring(date)
trustTypestring
trustTitlestring
trustAccessCodestring
amendedTrustDatestring(date)
governingStateOfTruststring
preferredCommunicationTypestring
preferredAddressIndicatorstring
identificationsarray[object]
Show Child Parameters
addressesarray[object]
Show Child Parameters
phonesarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
bankDetailsarray[object]

Bank details associated with a party

Show Child Parameters
versionstring
agentExternalIdstring
agentTypestring
agentPercentagenumber(double)
partyPercentagenumber(double)
collateralAmountnumber(double)
deathDetailsobject
Show Child Parameters
impairmentDetailsobject
Show Child Parameters
isPartyBeneficiaryNonNaturalboolean
isIrrevocableboolean
isRequiredMinimumDistributionDesignatedboolean
preferredAddressIdstring
preferredEmailIdstring
preferredPhoneIdstring
isAddressSameAsOwnerstring
Example