GET /sites/{site-identifier}/beneficiaries

Global

Return all member beneficiaries for the funds the user has access to.

get/sites/{site-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}/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: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

status'ALL' | 'EXPIRED' | 'EXPIRING-SOON' | 'NO-EXPIRY' | 'NO-NOMINATION'

Beneficiary status

Response

Success

FundGUIDstring guid

FundCodestring

FundNamestring

MemberGUIDstring guid

MemberNamestring

BeneficiaryGUIDstring guid

NominationTypestring

BindingExpiryDatestring date

Example response

[
  {
    "FundGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8",
    "FundCode": "Fund Code",
    "FundName": "Fund Name",
    "MemberGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f1",
    "MemberName": "Member Name",
    "BeneficiaryGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f2",
    "NominationType": "NON-BINDING",
    "BindingExpiryDate": "2023-01-01"
  }
]

Changes

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