# Beneficiary detail

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

Endpoint: GET /f/{businessCode}/{fundCode}/beneficiary-data/beneficiary-detail/{id}
Version: 1.0
Security: Class_oAuth

## Path parameters:

  - `businessCode` (string, required)
    Class business code

  - `fundCode` (string, required)
    Class entity code

  - `id` (any, required)
    A globally unique identifier (GUID) in standard UUID format to identify the beneficiary

## Response 200 fields (application/json):

  - `Data` (object, required)
    Response wrapper for retrieving beneficiary details, including the beneficiary data and any processing errors.

  - `Data.Data` (object)
    Beneficiary details returned by the system.

  - `Data.Data.Link` (object)
    Hypermedia link identifying the beneficiary resource.

  - `Data.Data.Link.Id` (string)
    Unique identifier of the beneficiary.
    Example: eef8e2fe-3000-47c6-9976-171c8f77a7f8

  - `Data.Data.Link.Url` (string)
    Fully qualified URL to retrieve this beneficiary resource.
    Example: https://api.class-test.com.au/api/1.0/f/API/DEMO_SummerDemo/beneficiary-data/beneficiary-detail/eef8e2fe-3000-47c6-9976-171c8f77a7f8

  - `Data.Data.Status` (string)
    Current lifecycle status of the beneficiary within the fund.
    Enum: "Active", "Suspended", "Cancelled"

  - `Data.Data.Number` (string)
    Beneficiary number within the fund.
    Example: 1

  - `Data.Data.TaxFileNumber` (string)
    Australian Tax File Number (TFN) of the beneficiary. May be null if not recorded.
    Example: null

  - `Data.Data.PartyType` (string)
    Indicates whether the beneficiary is an individual or an organisation.
    Enum: "Person", "Organisation"

  - `Data.Data.PersonalDetails` (object)
    Personal details applicable when the beneficiary is an individual.

  - `Data.Data.PersonalDetails.Title` (string)
    Title of the individual.
    Example: MR

  - `Data.Data.PersonalDetails.FirstName` (string)
    First name of the beneficiary.
    Example: John

  - `Data.Data.PersonalDetails.MiddleNames` (string)
    Middle names of the beneficiary.

  - `Data.Data.PersonalDetails.LastName` (string)
    Last name (surname) of the beneficiary.
    Example: Smith

  - `Data.Data.PersonalDetails.Gender` (string)
    Gender of the beneficiary.
    Example: Male

  - `Data.Data.PersonalDetails.DateOfBirth` (string)
    Date of birth of the beneficiary.
    Example: 1985-06-15

  - `Data.Data.PersonalDetails.PreferredSalutation` (string)
    Preferred salutation for correspondence.

  - `Data.Data.PersonalDetails.PreferredName` (string)
    Preferred display or greeting name.
    Example: John

  - `Data.Data.OrganisationDetails` (object)
    Organisation details applicable when the beneficiary is an organisation.

  - `Data.Data.OrganisationDetails.OrganisationName` (string)
    Legal name of the organisation.
    Example: null

  - `Data.Data.ContactDetails` (object)
    Contact, address, and invitation information for the beneficiary.

  - `Data.Data.ContactDetails.PreferredVoiceContact` (string)
    Preferred voice contact method.
    Example: null

  - `Data.Data.ContactDetails.PreferredWrittenContact` (string)
    Preferred written communication method.
    Example: Email

  - `Data.Data.ContactDetails.HomePhone` (string)
    Home phone number.
    Example: null

  - `Data.Data.ContactDetails.WorkPhone` (string)
    Work phone number.

  - `Data.Data.ContactDetails.Mobile` (string)
    Mobile phone number.
    Example: null

  - `Data.Data.ContactDetails.Direct` (string)
    Direct phone number.
    Example: null

  - `Data.Data.ContactDetails.Fax` (string)
    Fax number.
    Example: null

  - `Data.Data.ContactDetails.Email` (string)
    Email address used for correspondence.

  - `Data.Data.ContactDetails.InvitationDetails` (object)
    Invitation and access status information for the beneficiary.

  - `Data.Data.ContactDetails.InvitationDetails.InvitationStatus` (string)
    Current invitation status for beneficiary user access.
    Example: NotInvited

  - `Data.Data.ContactDetails.InvitationDetails.CanInviteUsers` (boolean)
    Indicates whether the beneficiary is permitted to invite users.
    Example: true

  - `Data.Data.ContactDetails.InvitationDetails.PersistedEmailAddress` (string)
    Email address associated with existing invitations.

  - `Data.Data.ContactDetails.InvitationDetails.BeneficiaryId` (string)
    Identifier of the beneficiary associated with the invitation.
    Example: eef8e2fe-3000-47c6-9976-171c8f77a7f8

  - `Data.Data.ContactDetails.UsePhysicalAddressForMailingAddress` (boolean)
    Indicates whether the physical address is also used as the mailing address.
    Example: true

  - `Data.Data.ContactDetails.PhysicalAddress` (object)
    Physical (residential or business) address of the beneficiary.

  - `Data.Data.ContactDetails.PhysicalAddress.Type` (string)
    Address usage type.
    Example: Physical

  - `Data.Data.ContactDetails.PhysicalAddress.Addressee` (string)
    Care-of or addressee name.
    Example: null

  - `Data.Data.ContactDetails.PhysicalAddress.Line1` (string)
    Address line 1.

  - `Data.Data.ContactDetails.PhysicalAddress.Line2` (string)
    Address line 2.

  - `Data.Data.ContactDetails.PhysicalAddress.Line3` (string)
    Address line 3.

  - `Data.Data.ContactDetails.PhysicalAddress.Line4` (string)
    Address line 4.

  - `Data.Data.ContactDetails.PhysicalAddress.Suburb` (string)
    Suburb or locality.

  - `Data.Data.ContactDetails.PhysicalAddress.State` (string)
    State or region.

  - `Data.Data.ContactDetails.PhysicalAddress.PostCode` (string)
    Postal code.

  - `Data.Data.ContactDetails.PhysicalAddress.ValidateAddress` (boolean)
    Indicates whether the address has been validated.
    Example: false

  - `Data.Data.ContactDetails.PhysicalAddress.Country` (string)
    Country code of the physical address.
    Example: AUS

  - `Data.Data.ContactDetails.MailingAddress` (object)
    Mailing address of the beneficiary.

  - `Data.Data.ContactDetails.MailingAddress.Type` (string)
    Address usage type.
    Example: Mailing

  - `Data.Data.ContactDetails.MailingAddress.Addressee` (string)
    Care-of or addressee name.

  - `Data.Data.ContactDetails.MailingAddress.Line1` (string)
    Address line 1.

  - `Data.Data.ContactDetails.MailingAddress.Line2` (string)
    Address line 2.

  - `Data.Data.ContactDetails.MailingAddress.Line3` (string)
    Address line 3.

  - `Data.Data.ContactDetails.MailingAddress.Line4` (string)
    Address line 4.

  - `Data.Data.ContactDetails.MailingAddress.Suburb` (string)
    Suburb or locality.

  - `Data.Data.ContactDetails.MailingAddress.State` (string)
    State or region.

  - `Data.Data.ContactDetails.MailingAddress.PostCode` (string)
    Postal code.

  - `Data.Data.ContactDetails.MailingAddress.ValidateAddress` (boolean)
    Indicates whether the address has been validated.
    Example: false

  - `Data.Data.ContactDetails.MailingAddress.Country` (string)
    Country code of the mailing address.
    Example: AUS

  - `Errors` (array)

  - `Errors.code` (string)

  - `Errors.message` (string)

## Response 400 fields (application/json):

  - `Errors` (array)

  - `Errors.code` (string)

  - `Errors.message` (string)

## Response 401 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_NOT_AUTHORISED

  - `Errors.Message` (string)
    Example: Not authorised

## Response 403 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: FORBIDDEN

  - `Errors.Message` (string)
    Example: You do not have permission to access this resource.

## Response 404 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_NOT_FOUND

  - `Errors.Message` (string)
    Example: Resource not available or user does not have access to the fund.

## Response 500 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_INTERNAL_ERROR

  - `Errors.Message` (string)
    Example: An unexpected error occurred on the server. Please try again later.

## Response default fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_INTERNAL_ERROR

  - `Errors.Message` (string)
    Example: An unexpected error occurred on the server. Please try again later.