Beneficiary detail

Request

Retrieves the complete details of a specific beneficiary including personal information, contact details, tax file number, and organisation details if applicable.

Security

Class_oAuth(Required scopes: fund.member.read)

Path

businessCodestringrequired

Class business code

Example:demo-business

fundCodestringrequired

Class entity code

Example:demo-fund

idanyrequired

A globally unique identifier (GUID) in standard UUID format to identify the beneficiary

Example:550e8400-e29b-41d4-a716-446655440000

curl -i -X GET \
  https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/beneficiary-data/beneficiary-detail/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json

Dataobjectrequired

Response wrapper for retrieving beneficiary details, including the beneficiary data and any processing errors.

ErrorsArray of objects

Response

{
  "Data": {
    "Data": {
      "Link": {
        "Id": "eef8e2fe-3000-47c6-9976-171c8f77a7f8",
        "Url": "https://api.class-test.com.au/api/1.0/f/API/DEMO_SummerDemo/beneficiary-data/beneficiary-detail/eef8e2fe-3000-47c6-9976-171c8f77a7f8"
      },
      "Status": "Active",
      "Number": "1",
      "TaxFileNumber": null,
      "PartyType": "Person",
      "PersonalDetails": {
        "Title": "MR",
        "FirstName": "John",
        "MiddleNames": "",
        "LastName": "Smith",
        "Gender": "Male",
        "DateOfBirth": "1985-06-15",
        "PreferredSalutation": "",
        "PreferredName": "John"
      },
      "OrganisationDetails": {
        "OrganisationName": null
      },
      "ContactDetails": {
        "PreferredVoiceContact": null,
        "PreferredWrittenContact": "Email",
        "HomePhone": null,
        "WorkPhone": "",
        "Mobile": null,
        "Direct": null,
        "Fax": null,
        "Email": "",
        "InvitationDetails": {
          "InvitationStatus": "NotInvited",
          "CanInviteUsers": true,
          "PersistedEmailAddress": "",
          "BeneficiaryId": "eef8e2fe-3000-47c6-9976-171c8f77a7f8"
        },
        "UsePhysicalAddressForMailingAddress": true,
        "PhysicalAddress": {
          "Type": "Physical",
          "Addressee": null,
          "Line1": "",
          "Line2": "",
          "Line3": "",
          "Line4": "",
          "Suburb": "",
          "State": "",
          "PostCode": "",
          "ValidateAddress": false,
          "Country": "AUS"
        },
        "MailingAddress": {
          "Type": "Mailing",
          "Addressee": "",
          "Line1": "",
          "Line2": "",
          "Line3": "",
          "Line4": "",
          "Suburb": "",
          "State": "",
          "PostCode": "",
          "ValidateAddress": false,
          "Country": "AUS"
        }
      }
    }
  },
  "Errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}