Beneficiary
No description
type Beneficiary {
address: PhysicalAddress
allocation: Int!
beneficiaryPriority: BeneficiaryPriority!
beneficiaryType: BeneficiaryType!
dateOfBirth: String
email: EmailAddress
id: ID!
personName: BeneficiaryPersonName
personRelationship: PersonRelationship
phoneNumber: String
tin: String
trustFormationDate: String
trustName: String
}
Fields
Beneficiary.address ● PhysicalAddress object
Address of beneficiary
Beneficiary.allocation ● Int! non-null scalar
Allocation percentage the beneficiary will receive upon disbursement
Beneficiary.beneficiaryPriority ● BeneficiaryPriority! non-null enum
Indicates whether the beneficiary is primary or contingent
Beneficiary.beneficiaryType ● BeneficiaryType! non-null enum
Type of beneficiary, e.g. Person, Trust, Estate...
Beneficiary.dateOfBirth ● String scalar
Date of birth of beneficiary if the beneficiary is a person
Beneficiary.email ● EmailAddress scalar
Email address of beneficiary
Beneficiary.id ● ID! non-null scalar
Unique ID of the beneficiary
Beneficiary.personName ● BeneficiaryPersonName object
Name of beneficiary if the beneficiary is a person
Beneficiary.personRelationship ● PersonRelationship enum
Relationship of beneficiary if the beneficiary is a person
Beneficiary.phoneNumber ● String scalar
Phone number of beneficiary
Beneficiary.tin ● String scalar
Tax identification number of the beneficiary
Beneficiary.trustFormationDate ● String scalar
Formation date of trust if the beneficiary is a trust
Beneficiary.trustName ● String scalar
Name of trust if the beneficiary is a trust
Member of
AddBeneficiaryPayload object ● Beneficiaries object ● UpdateBeneficiaryPayload object