# Update beneficiary detail

Updates the details of a specific beneficiary including personal information, contact details, and organisation details.

Endpoint: POST /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

## Request fields (application/json):

  - `Status` (string, required)
    The lifecycle status of the beneficiary within the fund. This value determines whether the beneficiary is active, suspended, or cancelled.
    Enum: "Active", "Suspended", "Cancelled"

  - `Number` (string, required)
    The beneficiary’s unique number within the fund. This is used to identify the beneficiary for reporting and administration purposes.
    Example: 1

  - `TaxFileNumber` (string)
    The Australian Tax File Number (TFN) of the beneficiary. This field is optional and only applicable where a TFN is available and permitted to be stored.
    Example: 123456789

  - `PartyType` (string, required)
    Indicates whether the beneficiary is an individual person or an organisation. This value determines which detail object (PersonalDetails or OrganisationDetails) is required.
    Enum: "Person", "Organisation"

  - `PersonalDetails` (object)
    Personal information about an individual beneficiary. This object is required when PartyType is set to Person.

  - `PersonalDetails.Title` (string)
    Title of the individual (e.g. Mr, Mrs, Ms). The value must match a supported salutation code.
    Example: MR

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

  - `PersonalDetails.MiddleNames` (string)
    Middle names of the beneficiary, if applicable.
    Example: William

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

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

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

  - `PersonalDetails.PreferredSalutation` (string)
    Preferred salutation used for correspondence.
    Example: Mr

  - `PersonalDetails.PreferredName` (string)
    Preferred name used for display or greetings.
    Example: Johnny

  - `OrganisationDetails` (object)
    Organisation information for a non-individual beneficiary. This object is required when PartyType is set to Organisation.

  - `OrganisationDetails.OrganisationName` (string)
    The registered legal name of the organisation.
    Example: Acme Corporation Pty Ltd

  - `ContactDetails` (object, required)
    Contact and address information for the beneficiary. Address information is mandatory to ensure the beneficiary has a valid physical and mailing location recorded.

  - `ContactDetails.PreferredVoiceContact` (string)
    Preferred voice contact method (e.g. Mobile, Home, Work).
    Example: Mobile

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

  - `ContactDetails.HomePhone` (string)
    Home phone number of the beneficiary.
    Example: 61298765432

  - `ContactDetails.WorkPhone` (string)
    Work phone number of the beneficiary.
    Example: 61212345678

  - `ContactDetails.Mobile` (string)
    Mobile phone number of the beneficiary.
    Example: 61400123456

  - `ContactDetails.Fax` (string)
    Fax number of the beneficiary, if applicable.
    Example: 61299999999

  - `ContactDetails.Direct` (string)
    Direct phone number of the beneficiary.
    Example: 61212345679

  - `ContactDetails.Email` (string)
    Email address used for correspondence and invitations.
    Example: john.smith@example.com

  - `ContactDetails.UsePhysicalAddressForMailingAddress` (boolean, required)
    Indicates whether the physical address should also be used as the mailing address. When set to true, the mailing address details may mirror the physical address.
    Example: true

  - `ContactDetails.PhysicalAddress` (object, required)
    The physical (residential or business) address of the beneficiary. A valid country must always be supplied.

  - `ContactDetails.PhysicalAddress.Line1` (string)
    Address line 1.
    Example: 123 George Street

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

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

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

  - `ContactDetails.PhysicalAddress.Suburb` (string)
    Suburb or locality.
    Example: Sydney

  - `ContactDetails.PhysicalAddress.State` (string)
    State or region.
    Example: NSW

  - `ContactDetails.PhysicalAddress.PostCode` (string)
    Postal code.
    Example: 2000

  - `ContactDetails.PhysicalAddress.ValidateAddress` (boolean)
    Indicates whether the address has been validated through an address verification process.
    Example: false

  - `ContactDetails.PhysicalAddress.Country` (string, required)
    Country code of the physical address. The value must uniquely identify a supported country.
    Example: AU

  - `ContactDetails.MailingAddress` (object, required)
    The mailing address of the beneficiary. This address is always required, even when the physical address is used for mailing purposes.

  - `ContactDetails.MailingAddress.Addressee` (string)
    Name of the addressee or care-of recipient for mail.
    Example: John Smith

  - `ContactDetails.MailingAddress.Line1` (string)
    Address line 1.
    Example: 123 George Street

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

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

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

  - `ContactDetails.MailingAddress.Suburb` (string)
    Suburb or locality.
    Example: Sydney

  - `ContactDetails.MailingAddress.State` (string)
    State or region.
    Example: NSW

  - `ContactDetails.MailingAddress.PostCode` (string)
    Postal code.
    Example: 2000

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

  - `ContactDetails.MailingAddress.Country` (string, required)
    Country code of the mailing address.
    Example: AU

## Response 200 fields (application/json):

  - `ErrorCodes` (array, required)

  - `Errors` (array, required)

  - `Errors.Code` (string, required)

  - `Errors.Message` (string, required)

  - `CreatedUri` (string, required)

  - `IsCreatedResponse` (boolean, required)

## 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.