Members

<b>BETA:</b> Get member insurance.

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

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}/insurance
  • 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, fund_read, fund:members_read)

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

InsuranceGUIDstring guid
MemExtstring
Descriptionstring
CoverTypestring
Insurerstring
PolicyNumberstring
PolicyCommencementDatestring date
StartDatestring date
EndDatestring date
SumInsurednumber double
Premiumnumber double
PremiumFrequencystring

Example response

[
  {
    "InsuranceGUID": "b2f2b136-23b4-3b9b-8114-9a8a4c2d35d3",
    "MemExt": "00001",
    "Description": "Death and Total Permanent Disability cover - AMP XXX666",
    "CoverType": "DEATH_TPD",
    "Insurer": "AMP",
    "PolicyNumber": "ABC1234",
    "SumInsured": 5000000,
    "Premium": 500,
    "PremiumFrequency": "M",
    "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"
    }
  }
]

Changes

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