Skip to content

Beneficiaries

Named beneficiaries and their per-account allocations.

Beneficiary

message Beneficiary {
  enum Status {
    UNKNOWN_STATUS = 0;
    PENDING = 1;
    CONFIRMED = 2;
  }

  string uuid = 1;
  string given_name = 2 [debug_redact = true];
  string surname = 3 [debug_redact = true];
  com.basiccapital.common.external.BeneficiaryRelationship relationship = 4;
  Date date_of_birth = 5 [debug_redact = true];
  string email = 6 [debug_redact = true];
  string phone_number = 7 [debug_redact = true];
  com.basiccapital.common.external.Address address = 8 [debug_redact = true];
  Status status = 9;
  repeated BeneficiaryAllocation allocations = 10;
}

References: BeneficiaryAllocation, Date

BeneficiaryInfo

message BeneficiaryInfo {
  string given_name = 1 [debug_redact = true];
  string surname = 2 [debug_redact = true];
  com.basiccapital.common.external.BeneficiaryRelationship relationship = 3;
  Date date_of_birth = 4 [debug_redact = true];
  string email = 5 [debug_redact = true];
  string phone_number = 6 [debug_redact = true];
  com.basiccapital.common.external.Address address = 7 [debug_redact = true];
  repeated BeneficiaryAllocationInfo allocation_info = 8;
}

References: BeneficiaryAllocationInfo, Date

UpdateBeneficiaryInfo

message UpdateBeneficiaryInfo {
  string beneficiary_uuid = 1;
  optional string given_name = 2 [debug_redact = true];
  optional string surname = 3 [debug_redact = true];
  optional com.basiccapital.common.external.BeneficiaryRelationship relationship = 4;
  optional Date date_of_birth = 5 [debug_redact = true];
  optional string email = 6 [debug_redact = true];
  optional string phone_number = 7 [debug_redact = true];
  optional com.basiccapital.common.external.Address address = 8 [debug_redact = true];
  repeated BeneficiaryAllocationInfo allocation_info = 9;
}

References: BeneficiaryAllocationInfo, Date

BeneficiaryAllocation

message BeneficiaryAllocation {
  string beneficiary_uuid = 1;
  optional string account_uuid = 2;
  int32 allocation_bps = 3;
}

BeneficiaryAllocationInfo

message BeneficiaryAllocationInfo {
  optional string account_uuid = 1;
  int32 allocation_bps = 2;
}