Members

Get beneficiaries.

get/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/beneficiaries

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/beneficiaries
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

member-identifierstring required

The GUID that identifies a member

Response

Success

NominationTypestring
BindingExpiryDatestring date
Commentsstring

Example response

{
  "Document": {
    "GUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0",
    "DownloadUrl": "http://domain.com/api/v1/sites/ABC/documents/ef1f02ff-738e-4bbd-8214-fbe4742d70e0/content",
    "FileName": "example.docx"
  },
  "Beneficiaries": [
    {
      "BeneficiaryGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
      "Relationship": "SPOUSE",
      "MemberGUID": "e7eec8e2-87c2-04bb-8014-6934608e99f9",
      "Title": "Mr",
      "FirstName": "Craig",
      "LastName": "Anderson",
      "Percentage": 10,
      "BirthDate": "1989-02-28",
      "TFNRecorded": true,
      "PostalAddressLine1": "23 Main Street",
      "PostalAddressLine2": "Apt 4B",
      "PostalSuburb": "Queen",
      "PostalState": "QLD",
      "PostalPostcode": "4103",
      "PostalCountry": "Australia",
      "Comments": "Beneficiary comment example."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.