Search
K
New-Business

Beneficiary

object
partyIdstring(uuid)required

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestringrequired

Type of party role

Allowed values:PRIMARYBENEFICIARYCONTINGENTBENEFICIARY

Example:PRIMARYBENEFICIARY

partyTypestringrequired

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

irrevocableBeneboolean

Indicates whether the beneficiary designation is irrevocable. Applicable only for the Beneficiary party and accepted regardless of the party type (individual, organization, or trust). Defaults to false when not provided.

Default:false

Example:true

beneficiaryShareMethodstring

Share method for the beneficiary designation. Applicable only for the Beneficiary party and supported for both Primary and Contingent beneficiary roles. When not provided, no share method is sent to the system of record.

Allowed values:PER_STIRPES_DISTRIBUTION

Example:PER_STIRPES_DISTRIBUTION

relationshipobjectrequired
Show Child Parameters
personalInformationOne Of
required
TrustDetailsobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

BeneficiaryPatch

object
partyIdstring(uuid)

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestring

Type of party role

Allowed values:PRIMARYBENEFICIARYCONTINGENTBENEFICIARY

Example:PRIMARYBENEFICIARY

partyTypestring

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

irrevocableBeneboolean

Indicates whether the beneficiary designation is irrevocable. Applicable only for the Beneficiary party and accepted regardless of the party type (individual, organization, or trust). Defaults to false when not provided.

Default:false

Example:true

beneficiaryShareMethodstring

Share method for the beneficiary designation. Applicable only for the Beneficiary party and supported for both Primary and Contingent beneficiary roles. When not provided, no share method is sent to the system of record.

Allowed values:PER_STIRPES_DISTRIBUTION

Example:PER_STIRPES_DISTRIBUTION

relationshipobject
Show Child Parameters
personalInformationOne Of
TrustDetailsPatchobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierPatchobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

BeneficiaryResponse

object
partyIdstring(uuid)

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestring

Type of party role

Allowed values:PRIMARYBENEFICIARYCONTINGENT_BENEFICIARY

Example:PRIMARYBENEFICIARY

partyTypestring

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobject
Show Child Parameters
personalInformationOne Of
TrustDetailsResponseobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierResponseobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

Payor

object
partyIdstring(uuid)required

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestringrequired

Type of party role

Allowed values:PAYOR

Example:PAYOR

partyTypestringrequired

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobject
Show Child Parameters
personalInformationobjectrequired
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
employmentobject
Show Child Parameters
Example

PayorPatch

object
partyIdstring(uuid)

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestring

Type of party role

Allowed values:PAYOR

Example:PAYOR

partyTypestring

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobject
Show Child Parameters
personalInformationobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierPatchobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
employmentobject
Show Child Parameters
Example