Retrieve a Beneficiary

Retrieve a Beneficiary for a Customer Account. Beneficiaries can only belong to a Business Customer (not an Individual Customer).

Endpoint

GET /v1/customers/{customerId}/beneficiaries/{beneficiaryId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId REQUIRED

string (UUID)

ID of the Customer Account to which the Beneficiary belongs.

beneficiaryId REQUIRED

string (UUID)

ID of the Beneficiary.

Request Body

None

Returns

Returns the Beneficiary object. This object contains the Beneficiary details, including a unique ID for the Beneficiary.

SAMPLE RESPONSE

				
					{
  "parentId": "69248436-39f5-4074-9823-76d2580c82a6",
  "id": "997dec9d-afcb-4843-a9e3-5333b6228229",
  "firstName": "Natalie",
  "middleName": "Sue",
  "lastName": "Smith",
  "sex": "FEMALE",
  "primaryPhoneNumber": {
    "number": "+17512312345",
    "type": "MOBILE",
    "provider": "XYZ Mobile",
    "extension": "",
    "verified": false
  },
  "primaryEmail": {
    "value": "nsmith@example.com",
    "verified": false
  },
  "dateOfBirth": "1981-05-11",
  "placeOfBirth": {
    "city": "New York",
    "countryCode": "USA"
  },
  "socialId": "123-45-6789",
  "socialIdCountryCode": "USA",
  "citizenshipCountryCode": "CAN"
  "title": "CEO",
  "ownershipPercentage": "50",
  "controller": true,
  "addresses": [
    {
      "type": "MAILING",
      "streetLine1": "400 Richmond St",
      "streetLine2": "Suite 500",
      "streetLine3": "",
      "streetLine4": "",
      "streetLine5": "",
      "cityName": "New York",
      "stateCode": "NY",
      "countryCode": "USA",
      "zipCode": "10001",
      "primary": true
    }
  ],
  "createdBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "createdAt": "2023-05-20T00:42:50.311Z",
  "updatedBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "updatedAt": "2023-06-12T00:42:50.311Z"
}