{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Beneficiaries"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"beneficiaries","__idx":0},"children":["Beneficiaries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Named beneficiaries and their per-account allocations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"beneficiary","__idx":1},"children":["Beneficiary"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"protobuf","header":{"controls":{"copy":{}}},"source":"message Beneficiary {\n  enum Status {\n    UNKNOWN_STATUS = 0;\n    PENDING = 1;\n    CONFIRMED = 2;\n  }\n\n  string uuid = 1;\n  string given_name = 2 [debug_redact = true];\n  string surname = 3 [debug_redact = true];\n  com.basiccapital.common.external.BeneficiaryRelationship relationship = 4;\n  Date date_of_birth = 5 [debug_redact = true];\n  string email = 6 [debug_redact = true];\n  string phone_number = 7 [debug_redact = true];\n  com.basiccapital.common.external.Address address = 8 [debug_redact = true];\n  Status status = 9;\n  repeated BeneficiaryAllocation allocations = 10;\n}\n","lang":"protobuf"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["References:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/beneficiaries#beneficiaryallocation"},"children":["BeneficiaryAllocation"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/common#date"},"children":["Date"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"beneficiaryinfo","__idx":2},"children":["BeneficiaryInfo"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"protobuf","header":{"controls":{"copy":{}}},"source":"message BeneficiaryInfo {\n  string given_name = 1 [debug_redact = true];\n  string surname = 2 [debug_redact = true];\n  com.basiccapital.common.external.BeneficiaryRelationship relationship = 3;\n  Date date_of_birth = 4 [debug_redact = true];\n  string email = 5 [debug_redact = true];\n  string phone_number = 6 [debug_redact = true];\n  com.basiccapital.common.external.Address address = 7 [debug_redact = true];\n  repeated BeneficiaryAllocationInfo allocation_info = 8;\n}\n","lang":"protobuf"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["References:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/beneficiaries#beneficiaryallocationinfo"},"children":["BeneficiaryAllocationInfo"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/common#date"},"children":["Date"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"updatebeneficiaryinfo","__idx":3},"children":["UpdateBeneficiaryInfo"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"protobuf","header":{"controls":{"copy":{}}},"source":"message UpdateBeneficiaryInfo {\n  string beneficiary_uuid = 1;\n  optional string given_name = 2 [debug_redact = true];\n  optional string surname = 3 [debug_redact = true];\n  optional com.basiccapital.common.external.BeneficiaryRelationship relationship = 4;\n  optional Date date_of_birth = 5 [debug_redact = true];\n  optional string email = 6 [debug_redact = true];\n  optional string phone_number = 7 [debug_redact = true];\n  optional com.basiccapital.common.external.Address address = 8 [debug_redact = true];\n  repeated BeneficiaryAllocationInfo allocation_info = 9;\n}\n","lang":"protobuf"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["References:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/beneficiaries#beneficiaryallocationinfo"},"children":["BeneficiaryAllocationInfo"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/core-data-types/common#date"},"children":["Date"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"beneficiaryallocation","__idx":4},"children":["BeneficiaryAllocation"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"protobuf","header":{"controls":{"copy":{}}},"source":"message BeneficiaryAllocation {\n  string beneficiary_uuid = 1;\n  optional string account_uuid = 2;\n  int32 allocation_bps = 3;\n}\n","lang":"protobuf"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"beneficiaryallocationinfo","__idx":5},"children":["BeneficiaryAllocationInfo"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"protobuf","header":{"controls":{"copy":{}}},"source":"message BeneficiaryAllocationInfo {\n  optional string account_uuid = 1;\n  int32 allocation_bps = 2;\n}\n","lang":"protobuf"},"children":[]}]},"headings":[{"value":"Beneficiaries","id":"beneficiaries","depth":1},{"value":"Beneficiary","id":"beneficiary","depth":2},{"value":"BeneficiaryInfo","id":"beneficiaryinfo","depth":2},{"value":"UpdateBeneficiaryInfo","id":"updatebeneficiaryinfo","depth":2},{"value":"BeneficiaryAllocation","id":"beneficiaryallocation","depth":2},{"value":"BeneficiaryAllocationInfo","id":"beneficiaryallocationinfo","depth":2}],"frontmatter":{"title":"Beneficiaries","seo":{"title":"Beneficiaries"}},"lastModified":"2026-09-14T19:48:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/core-data-types/beneficiaries","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}