Investments

<b>BETA:</b> Returns all the investor reference details for the specified fund.

get/sites/{site-identifier}/funds/{fund-identifier}/investor-references

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}/investor-references
  • 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

Response

Success

InvestorReferenceIdentifierstring guid
InvestorReferenceGUIDstring guid
InvestorReferencestring
InterfaceCodestring
InterfaceNamestring
RegisteredNamestring
RegisteredPostCodestring
Type'HIN' | 'CERT' | 'SRN' | 'OTHER' | 'PLATFORM' | 'UNITHOLDER' | 'CRYPTO'
Registrystring
DividendNominationstring
Activeboolean
Brokerstring
AccountNumberstring
SecondaryReferenceSupportedboolean
Permissionsstring[]

Example response

{
  "InterfaceCode": "MACQUARIE-WRAP",
  "InterfaceName": "Macquarie Wrap",
  "DataFeed": {
    "Filters": {
      "ExcludeSecurityCodeList": "SEC,SEC1:*"
    }
  },
  "Platform": {
    "Code": "AMM"
  },
  "Permissions": [
    "delete"
  ]
}

Changes

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