API Reference

The Sargon API is organised around REST.

Our API has resource-oriented URLs, and uses HTTP response codes to indicate API errors.

We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code).

JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

To make the API as explorable as possible, we have test mode and production mode API keys. Requests made with test mode credentials are for prototyping only and do not hit our production systems.

Authentication

Authenticate your account by including your API Keys in your API requests.

You can manage your API keys in the Developer section of your account. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

You can hit the endpoints directly or use our API client libraries to easily get started.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Security

The API has been designed from the ground up with security in mind including access control, API security best practices including industry and widely accepted standards for authentication.

The security implementation within the API is part of a larger Sargon security environment and is enhanced by additional security measures at the network infrastructure and back-office system layers.

For production applications integrating with Sargon, an additional integration security assessment and monitoring as an additional layer of security. Please read our Security Guidelines.

Multiple Factor Authentication

Some API operations require additional authorisation through the use of a One Time Password (OTP) from the member. In these cases the API will return a HTTP Status 401 (Unauthorised) and provide additional information in the X-Super-OTP response header.

The format of the X-Super-OTP response header is:

X-Super-OTP: [status]

Status values:

  • required - A One-time password is required for this operation. Please retry the operation including X-Super-OTP header.
  • valid - A previous challenge is still valid and a challenge is not required for this operation.

When an OTP is required the client can request one using the /members/otp endpoint. This will return details of the generated code, including the type so that the client can prompt the user accordingly.

Supported OTP types:

  • sms - A text message with the One Time Password has been sent to the member's registered mobile phone.

Once the user has provided the code the request should be retried with the OTP code specified in the X-Super-OTP request header.

Pagination

Some top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list members and transactions.

These list API methods share a common structure, taking at least these three parameters: p (pagination page number), i (page size), and o (and the starting offset).

Errors

Sargon uses conventional HTTP response codes to indicate the success or failure of an API request.

In general:

  • Codes in the 2xx range indicate success.

  • Codes in the 4xx range indicate an error that failed given the information provided (e.g. required and/or insufficient parameters)

  • Codes in the 5xx range indicate an error with Sargon's servers (these are rare).

Errors that could be handled programmatically include an error code that briefly explains the error reported.

Versioning

We generally avoid make backwards-incompatible changes to the API. By default, all API calls will be made to the latest version of our API.

In special circumstances, you can set the API version on a specific request by using the Sargon-Version HTTP header or a corresponding API client library parameter.

Members

Member Resources represent the the Members of a fund and are the cornerstone of the API. All other resources are related to a Member.

The API allows member management (for funds), along with creation & management (for member self-service).

List Members
Sargon clients only - Available upon request

Returns a paginated collection of accessible members.

The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.

The Members Collection resource is subject to various limits and controls, these include:

  • Request Rate Limiting
  • Result Limiting
  • Minimum Query Length

The date search feature searches on the member joinedDate attribute.

Authorization

Integration
Scope: https://api.sargon.com/integration

Query Parameters

q

string

Collection Quick Search String.

"Quick Search" provides an easy to utilise multiple-attribute search mechanism. The fields searched by quick search vary depending

upon the resource type.

A quick search on Members MAY query the givenName, alternativeName, familyName and email attributes. A quick search on Funds MAY query the fund name, ABN, USI and product names.

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

memberNumber

string

Member Number or Range of Member Numbers to search

A Range can be specified separated by a comma in the form of memberNumber=min,max

If only one member number is specified that member will be searched for. If min is empty the API will search for all members up to and including max. If max is empty the API will search for all members from and including min and up.

Examples:

  • 30120020 - A single member number
  • 30120020,30120040 - A range of member numbers
  • ,30120040 - All member numbers up to and including 30120040
  • 30120040, - All member numbers from 30120040 and up, inclusive.

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

Responses

200 - Member Collection

data

array

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

429 - Rate Limited

errors

array

required

GET
https://api.sargon.com/v1/members
Example response: 200 - Member Collection
{ "data": [ { "familyName": "Doe", "flagInsured": true, "flagIsContributor": true, "givenName": "John", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "memberStatus": "Active", "suburb": "string", "updated": "2017-01-31T21:00Z" } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Example response: 429 - Rate Limited
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Create New Member

Creates a new Member.

No authentication (other than API Key) is required to create a new Member. On creation a valid access token with member scope will be returned in the response to be used for further api requests on behalf of this member.

New Members requests are created as temporary entities at the API level (not propagated to the backend) until the member has provided sufficient details and been identity verified.

Once a member has been identity verified, some attributes will no longer be updatable. These attributes are shown with an unverified indicator. If no postal address is supplied it will be defaulted to be the same as the residential address.

Authorization

UnauthenticatedUser

Request body

addressPostal

object

Postal Address. If not supplied will default to the same as residential address.

taxId

string

required

The Member's Tax Identifier. For Australia, this is the Tax File Number. This value may be obsificated by the API. In this case an asterisk will replace any masked characters.

familyName

string

required

The Member's family name. In western countries this is usually the surname or lastname.

givenName

string

required

The Member's given name. In western countries this is usually the first name.

addressResidential

object

required

Residential Address

birthDate

string

required

The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

email

string

required

Email Address

phoneMobile

string

required

Mobile Phone Number in E.164 international format, e.g. +61412345678.

Responses

201 - Member Created Resource

data

object

400 - Bad Request

errors

array

required

409 - Conflict - The email address has already been used

errors

array

required

POST
https://api.sargon.com/v1/members
Example request:
{ "addressPostal": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "taxId": "430 *** ***", "familyName": "Doe", "givenName": "John", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "john@test.com", "phoneMobile": "+61412345678" }
Example response: 201 - Member Created Resource
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "token": { "expires_in": 0, "id_token": "string", "token_type": "string" } } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 409 - Conflict - The email address has already been used
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Member
Sargon clients only - Available upon request

Return the full representation of the requested member by member UUID.

When accessed using member credentials the result is limited to the currently authenticated member.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Member Resource

data

object

Base Member Fields

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}
Example response: 200 - Member Resource
{ "data": { "familyName": "Doe", "flagInsured": true, "flagIsContributor": true, "givenName": "John", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressPostal": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "john@test.com", "idVerificationStatus": "Validated", "phoneMobile": "+61412345678", "taxIdStatus": "Supplied" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Member
Sargon clients only - Available upon request

Update or perform an operation on a Member resource.

Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a unverified indicator.

However they may be updated in certain circumstances including:

  • Self-serve with valid member credientials prior to the aquisition of a identity verification.
  • When accessed using fundOperator credentials and appropriate permissions.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Request body

familyName

string

The Member's family name. In western countries this is usually the surname or lastname.

givenName

string

The Member's given name. In western countries this is usually the first name.

addressPostal

object

Postal Address

addressResidential

object

Residential Address

birthDate

string

The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

email

string

Email Address

phoneMobile

string

Mobile Phone Number in E.164 international format, e.g. +61412345678.

password

string

User Password. If supplied in a request body, the user password will be changed. When changing a password the API MAY request an OTP challenge/response.

taxId

string

The Member's Tax Identifier. For Australia, this is the Tax File Number. This value may be obsificated by the API. In this case an asterisk will replace any masked characters.

Responses

200 - Member Resource

data

object

Base Member Fields

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}
Example request:
{ "familyName": "Doe", "givenName": "John", "addressPostal": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "john@test.com", "phoneMobile": "+61412345678", "password": "pa$$word", "taxId": "430 *** ***" }
Example response: 200 - Member Resource
{ "data": { "familyName": "Doe", "flagInsured": true, "flagIsContributor": true, "givenName": "John", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressPostal": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "john@test.com", "idVerificationStatus": "Validated", "phoneMobile": "+61412345678", "taxIdStatus": "Supplied" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Account Activity
Sargon clients only - Available upon request

List account activity for a Member resource.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Activity Collection Response

attachments

array

Array of Attachments attached to this event

description

string

required

Description of this event

effectiveDate

string

Timestamp of when this event takes effect.

eventCode

string

Internal event type of this event.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

initiatedBy

string

required

Indicator of how the event was initiated (by whom).

status

string

required

Status of this event

timeComplete

string

Timestamp of when this event was completed.

timeStart

string

Timestamp of when this event was initiated.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/activity
Example response: 200 - Activity Collection Response
[ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "description": "string", "effectiveDate": "2019-05-10T01:26:47Z", "eventCode": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "initiatedBy": "Member", "status": "Pending", "timeComplete": "2019-05-10T01:26:47Z", "timeStart": "2019-05-10T01:26:47Z" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Member Contacts
Sargon clients only - Available upon request

List contacts for a Member resource.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

contactType

string

Filter by Contact Type

Responses

200 - Contact Collection Response

address

object

Primary Address

contactType

string

Contact Type

created

string

Resource creation date/time in ISO 8601 format.

display

string

A human readable description of this resource, subresource or link.

email

string

Contact Email Address

phone

string

Contact Telephone Number

updated

string

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/contacts
Example response: 200 - Contact Collection Response
[ { "address": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "contactType": "Advisor", "created": "2017-01-31T21:00Z", "display": "Display Text", "email": "user@example.com", "phone": "string", "updated": "2017-01-31T21:00Z" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Beneficiaries

The Beneficiary Resource represents the nominated beneficiaries associated with a member.

Beneficiary Resources exist independently to the nominated beneficiary allocation. Beneficiaries must be created before they can be allocated to.

A usual workflow for a new member, may be processed as:

  • Add Beneficiary "Jane"

  • Add Beneficiary "Bob"

  • Update Beneficiary Allocation (50% to Jane, 50% to Bob)

List Beneficiaries
Sargon clients only - Available upon request

List beneficiaries for a member resource.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Beneficiary Collection Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

beneficiaryType

string

percentage

number

Percentage of total benefit to allocate this beneficiary.

400 - Bad Request

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries
Example response: 200 - Beneficiary Collection Response
[ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0 } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Add New Beneficiary
Sargon clients only - Available upon request

Add a new beneficiary for a member resource.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Request body

additionalName

string

The Person's additional name. This can be used for a members' middle names.

addressResidential

object

Residential Address

birthDate

string

Beneficiary Date of Birth

familyName

string

required

The Person's family name. In western countries this is usually the surname or lastname.

givenName

string

required

The Person's given name. In western countries this is usually the first name.

relationship

string

Beneficiary Relationship

Responses

201 - Created

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/beneficiaries
Example request:
{ "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2019-05-10", "familyName": "string", "givenName": "string", "relationship": "Child" }
Example response: 201 - Created
{ "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Historic Beneficiary Allocations
Sargon clients only - Available upon request

Return cash beneficiary allocations by effectiveDate. Note: The response may contain future allocations requested, but not yet effective.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

sort

string

Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

Responses

200 - Beneficiary Allocation Historic Collection Response

allocations

array

effectiveDate

string

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries/allocationhistory
Example response: 200 - Beneficiary Allocation Historic Collection Response
[ { "allocations": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ], "effectiveDate": "2019-05-10" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Beneficiary Allocations
Sargon clients only - Available upon request

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Beneficiary Allocation Collection Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

percent

number

required

Percentage to allocate

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries/allocations
Example response: 200 - Beneficiary Allocation Collection Response
[ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Beneficiary Allocation
Sargon clients only - Available upon request

Update the allocation of benefit across beneficiaries. Beneficiaries must be created with a call to the Create Beneficiary end point before an allocation can be made.

A representation of all allocations must be included in the request. The sum of all percentages specified MUST equal 100.

The response from Get Beneficiary Allocations may be updated with new percentages and supplied as the payload to this request. id and percent are required in each of the items within the payload array. All other meta attributes (full, display etc) will be ignored, if supplied.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

effectiveDate

string

Update the allocations effective from the supplied date. If provided must not be in the past. If not provided will default to today's date.

Request body

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

percent

number

required

Percentage to allocate

Responses

200 - Beneficiary Allocation Collection Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

percent

number

required

Percentage to allocate

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/beneficiaries/allocations
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]
Example response: 200 - Beneficiary Allocation Collection Response
[ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Beneficiary Detail
Sargon clients only - Available upon request

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

beneficiary

string

Unique UUID of the Beneficiary.

Responses

200 - Beneficiary Resource Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

beneficiaryType

string

percentage

number

Percentage of total benefit to allocate this beneficiary.

additionalName

string

The Person's additional name. This can be used for a members' middle names.

addressResidential

object

Residential Address

birthDate

string

Beneficiary Date of Birth

familyName

string

required

The Person's family name. In western countries this is usually the surname or lastname.

givenName

string

required

The Person's given name. In western countries this is usually the first name.

relationship

string

Beneficiary Relationship

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries/{beneficiary}
Example response: 200 - Beneficiary Resource Response
{ "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0, "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2019-05-10", "familyName": "string", "givenName": "string", "relationship": "Child" }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Beneficiary Detail
Sargon clients only - Available upon request

Update (Non-binding) Beneficiary details. HTTP Status 400 (Bad Request) will be returned by the API if the Update call is made on a Binding Beneficiary

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

beneficiary

string

Unique UUID of the Beneficiary.

Request body

additionalName

string

The Person's additional name. This can be used for a members' middle names.

addressResidential

object

Residential Address

birthDate

string

Beneficiary Date of Birth

familyName

string

required

The Person's family name. In western countries this is usually the surname or lastname.

givenName

string

required

The Person's given name. In western countries this is usually the first name.

relationship

string

Beneficiary Relationship

Responses

200 - Beneficiary Resource Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

beneficiaryType

string

percentage

number

Percentage of total benefit to allocate this beneficiary.

additionalName

string

The Person's additional name. This can be used for a members' middle names.

addressResidential

object

Residential Address

birthDate

string

Beneficiary Date of Birth

familyName

string

required

The Person's family name. In western countries this is usually the surname or lastname.

givenName

string

required

The Person's given name. In western countries this is usually the first name.

relationship

string

Beneficiary Relationship

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/beneficiaries/{beneficiary}
Example request:
{ "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2019-05-10", "familyName": "string", "givenName": "string", "relationship": "Child" }
Example response: 200 - Beneficiary Resource Response
{ "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0, "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2019-05-10", "familyName": "string", "givenName": "string", "relationship": "Child" }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Delete Beneficiary
Sargon clients only - Available upon request

Delete the specified Beneficiary If the beneficiary has an allocation, it must be set to zero using Update Beneficiary Allocations before deleting the beneficiary.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

beneficiary

string

Unique UUID of the Beneficiary.

Responses

204 - Empty Body
400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

DELETE
https://api.sargon.com/v1/members/{member}/beneficiaries/{beneficiary}
Example response: 204 - Empty Body
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Investments

Investment Resources represent individual investments made on behalf of the Member.

Switch Between Investments
Sargon clients only - Available upon request

Switch Between Investment

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

investment

string

Unique UUID of the Investment

destination

string

Unique UUID of the Destination Investment

Query Parameters

effectiveDate

string

Update the allocations effective from the supplied date. If provided must not be in the past. If not provided will default to today's date.

Request body

amount

number

Dollar Amount to transfer from source investment to destination investment.

percent

number

Percentage of the source investment to transfer to the destination investment.

Responses

201 - Created

data

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/investments/{investment}/switch/{destination}
Example request:
{ "amount": 0, "percent": 0 }
Example response: 201 - Created
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Future Cash Allocations

Get most recent future cash allocations

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Contribution Allocation Collection Response

data

array

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/futurecash
Example response: 200 - Contribution Allocation Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Future Cash Allocations

Update the Future Cash Allocations.

This Resource accepts a JSON array of ContributionAllocation Resources which each contain an pointer to an Investment Resource and percentage attribute. A representation of all allocations must be included in the request. The sum of all percentages specified MUST equal 100.

The response from Get Future Cash Allocations may be updated with new percentages and supplied as the payload to this request. id and percent are required in each of the items within the payload array. All other meta attributes (full, display etc) will be ignored, if supplied.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

effectiveDate

string

Update the allocations effective from the supplied date. If provided must not be in the past. If not provided will default to today's date.

Request body

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

percent

number

required

Percentage to allocate

Responses

200 - Contribution Allocation Collection Response

data

array

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/futurecash
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]
Example response: 200 - Contribution Allocation Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Historic Cash Allocations
Sargon clients only - Available upon request

Return cash allocation settings by effectiveDate.

Note: The response may contain future allocations requested, but yet effective.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

sort

string

Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

Responses

200 - Future Cash Allocation Historic Collection Response

allocations

array

effectiveDate

string

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/futurecashhistory
Example response: 200 - Future Cash Allocation Historic Collection Response
[ { "allocations": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ], "effectiveDate": "2019-05-10" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Member's Investments
Sargon clients only - Available upon request

List of Investments for the requested Member

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

all

boolean

Show all available Investments, not just those the member has Holdings in.

Responses

200 - Investment Collection Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

canBuy

boolean

This investment can be purchased.

canSell

boolean

This investment can be sold.

units

number

The number of units that this investment represents.

valuation

object

Valuation of this investment. The integrator MUST also include the information from updated when referring to the valuation. This attribute is not included if the member does not having holdings in this investment.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments
Example response: 200 - Investment Collection Response
[ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "canBuy": true, "canSell": true, "units": 0, "valuation": { "amount": 100.1, "currency": "AUD" } } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Available Investment Options

Returns a collection of investment options that can be activated for this member.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Investment Options Collection Response

data

array

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/options
Example response: 200 - Investment Options Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "description": "string", "displayName": "string", "legacy": true } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Retrieve Historical Performance Data
Sargon clients only - Available upon request

Returns a representation of Performance Data for the specified date range, frequency and investments.

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

type

string

Type of performance data to return. Valid values are:

  • unitprice - return historical unit prices for the specified investments.
  • value - return historical estimated value of a member's holdings within the specified investments.
  • fum - return all information for funds under management.

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

sort

string

Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

frequency

string

Reporting Frequency of the resulting data

investment

array

UUID of the Investment to query. This parameter accepts a comma separated list of investment UUIDs.

Responses

200 - FUM Graph Data

display

string

A human readable description of this resource, subresource or link.

series

array

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/performance
Example response: 200 - FUM Graph Data
{ "display": "Display Text", "series": [ { "display": "Display Text", "points": [ { "index": 1, "label": "Unit Price as of 31st Jan 2016", "value": 3.2 } ], "units": "AUD" } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Member's Investment Details
Sargon clients only - Available upon request

Get Investment Details

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

investment

string

Unique UUID of the Investment

Responses

200 - Investment Resource Response

created

string

required

Resource creation date/time in ISO 8601 format.

display

string

required

A human readable description of this resource, subresource or link.

full

string

required

Link to the "full" representation of the resource.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

updated

string

required

Resource last updated date/time in ISO 8601 format.

canBuy

boolean

This investment can be purchased.

canSell

boolean

This investment can be sold.

units

number

The number of units that this investment represents.

valuation

object

Valuation of this investment. The integrator MUST also include the information from updated when referring to the valuation. This attribute is not included if the member does not having holdings in this investment.

buyPrice

object

The latest buy price known sell price for this investment.

investmentDescription

string

Additional human readable description of the investmentType

investmentType

string

Fund-wide identifier for the type of Investment held in this account.

sellPrice

object

The latest sell price known sell price for this investment.

400 - Bad Request

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/{investment}
Example response: 200 - Investment Resource Response
{ "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "canBuy": true, "canSell": true, "units": 0, "valuation": { "amount": 100.1, "currency": "AUD" }, "buyPrice": { "amount": 100.1, "currency": "AUD" }, "investmentDescription": "string", "investmentType": "string", "sellPrice": { "amount": 100.1, "currency": "AUD" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Request Investment Rebalance
Sargon clients only - Available upon request

Request a rebalance of investments based on the supplied Investment Allocations. This Resource accepts a JSON array of ContributionAllocation Resources which each contain an pointer to an Investment Resource and percentage attribute.

The entire representation of all allocations must be included in the request and the percentage attributes across the array MUST add to 100%. Any Investment Resources not included in the representation will be set to 0%.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

effectiveDate

string

Update the allocations effective from the supplied date. If provided must not be in the past. If not provided will default to today's date.

Request body

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

percent

number

required

Percentage to allocate

Responses

204 - Empty Body
400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/rebalance
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]
Example response: 204 - Empty Body
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Insurance

Insurance Resources represent the Insurance Policies associated with the Member.

For the purpose of this section the following terms are defined:

  • Insurance Policy - A policy that may be added to a members profile

  • Insurance Cover - An insurance policy attached to a members profile

Insurance Policies may require additional questions to be answered by the member. Making an OPTIONS call to the policy endpoint will return a JSON Schema response containing full details of the additional attributes/questions to be supplied when applying for the policy.

List Member's Insurance Covers
Sargon clients only - Available upon request

Collection of Insurance Covers for this Member

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Insurance Covers Collection Response

data

array

links

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/covers
Example response: 200 - Insurance Covers Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "coverAmount": { "amount": 10010, "currency": "AUD" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2019-05-10", "effectiveTo": "2019-05-10", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "status": "PENDING", "terms": [ "string" ] } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Apply for Insurance Cover

Create an application for a new Insurance Cover for this member, using the specified Insurance Policy. Additional dynamic properties are supported in the request payload depending on the policy being created. Refer to Get Available Policy By ID for retrieving the JSON Schema for a specific Policy. Use status "OPT_OUT", if member wants to opt out from a specific insurance policy.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Request body

application

object

JSON object conforming to the Insurance Policy schema

policyId

string

required

status

string

terms

array

Responses

201 - Insurance Covers Response

data

array

links

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/insurance/covers
Example request:
[ { "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "policyId": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1", "status": "OPT_OUT", "terms": [ "string" ] } ]
Example response: 201 - Insurance Covers Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "coverAmount": { "amount": 10010, "currency": "AUD" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2019-05-10", "effectiveTo": "2019-05-10", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "status": "PENDING", "terms": [ "string" ] } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Insurance Cover Details
Sargon clients only - Available upon request

Retrieve the full details of the specified Insurance Cover

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

policy

string

Unique UUID of the Insurance Cover

Responses

200 - Insurance Cover Response

data

object

links

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/covers/{coverId}
Example response: 200 - Insurance Cover Response
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "coverAmount": { "amount": 10010, "currency": "AUD" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2019-05-10", "effectiveTo": "2019-05-10", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "status": "PENDING", "terms": [ "string" ], "benefitPeriod": "string", "waitPeriod": "string" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Insurance Cover Details
Sargon clients only - Available upon request

Update details of the specified Insurance Cover

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

policy

string

Unique UUID of the Insurance Cover

Request body

application

object

JSON object conforming to the Insurance Policy schema

terms

array

Responses

200 - Insurance Cover Response

data

object

links

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/insurance/covers/{coverId}
Example request:
{ "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "terms": [ "string" ] }
Example response: 200 - Insurance Cover Response
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "application": { "dob": "1980-01-31", "gender": "Female", "policy_id": "00dac6bb-fefe-4935-a0b4-f45fef00b9a1" }, "coverAmount": { "amount": 10010, "currency": "AUD" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2019-05-10", "effectiveTo": "2019-05-10", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "status": "PENDING", "terms": [ "string" ], "benefitPeriod": "string", "waitPeriod": "string" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Request Insurance Cover Cancellation
Sargon clients only - Available upon request

Request cancellation an existing (active) insurance policy.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

policy

string

Unique UUID of the Insurance Cover

Responses

204 - Empty Body
400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

DELETE
https://api.sargon.com/v1/members/{member}/insurance/covers/{coverId}
Example response: 204 - Empty Body
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Available Insurance Policies

Returns a collection of insurance policies that can be attached to or activated for this member.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - Insurance Policy Collection Response

data

array

links

object

400 - Bad Request

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/policies
Example response: 200 - Insurance Policy Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "commencementDate": "2019-05-10", "currentStatus": "AVAILABLE", "description": "string", "policyType": "TPD" } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Get Available Insurance Policy

Returns a specified insurance policy by ID, that can be attached to or activated for this member. It also returns a JSON Schema definition for the fields required to create a policy from this policy. A consumer SHOULD ensure that the payload used when creating a new policy from this policy validates against this schema. "JSON Schema" is a well supported standard for annotating and validating JSON data. See http://json-schema.org/

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member
Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

policy

string

Unique UUID of the Insurance Policy.

Responses

200 - Insurance Policy Response

data

object

links

object

400 - Bad Request

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/policies/{policyId}
Example response: 200 - Insurance Policy Response
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "commencementDate": "2019-05-10", "currentStatus": "AVAILABLE", "description": "string", "policyType": "TPD", "schema": {} }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Transactions

Transaction Resources represent individual transactions for a member or investment.

All Transaction details are returned as a read-only collection and the API does not provide any operations at the Resource level.

List Transactions
Sargon clients only - Available upon request

List Transactions. Defaults to transactions belonging to the currently authenticated member when accessed with member credentials. If authenticated using fundOperator credentials, a member UUID may be specified as a query parameter to limit results to the specified member.

Authorization

Integration
Scope: https://api.sargon.com/integration

Query Parameters

member

string

Show only Transactions belonging to the specified Member.

This option is only available to fund and integration authorisation levels.

Member authentication will default to the currently authenticated member.

type

string

Show only Transactions of the specified type.

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

amount

string

Return results for the specified amount (or amount range). Amount can be provided with up to two decimal places (e.g. 3200.32).

A Range can be specified separated by a comma in the form of amount=lower,higher

If only one amount is specified the API will return results matching only that amount. If lower is empty the API will search for all amounts below and including the higher amount. If higher is empty the API will search for all amounts above and including the lower amount.

Examples:

  • 3012.12 - Match an exact value of 3012.12 only
  • 100, - Match any amount equal to or above 100
  • ,100 - Match any amount equal to or below 100
  • 100,200 - Match an value between 100 and 200, inclusive

q

string

Collection Quick Search String.

"Quick Search" provides an easy to utilise multiple-attribute search mechanism. The fields searched by quick search vary depending

upon the resource type.

A quick search on Members MAY query the givenName, alternativeName, familyName and email attributes. A quick search on Funds MAY query the fund name, ABN, USI and product names.

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

sort

string

Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

Responses

200 - Transaction Collection

amountIn

object

The amount credited to this investment as a result of this transaction represented as a floating point number with 2 digit precision.

amountOut

object

The amount debited from this investment as a result of this transaction represented as a floating point number with 2 digit precision.

balance

object

required

The balance as a result of this transaction represented as a floating point number with 2 digit precision.

coa

string

Internal COA Code this transaction is linked to.

display

string

required

A human readable description of this resource, subresource or link.

effectiveDate

string

The effective date of this transaction in ISO 8601 format.

id

string

required

The Universally Unique Resource Identifier (UUID) for this Resource.

member

string

URI of the associated Member resource

paidDate

string

The date this transaction was settled in ISO 8601 format.

transactionType

string

Transaction Type. List of Transaction types will vary based on specific Fund configuration.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/transactions
Example response: 200 - Transaction Collection
[ { "amountIn": 9121.34, "amountOut": 8234.21, "balance": { "amount": 100.1, "currency": "AUD" }, "coa": "string", "display": "Display Text", "effectiveDate": "2015-01-19T17:50:00.000Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "member": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "paidDate": "2015-01-19T17:50:00.000Z", "transactionType": "Contribution" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Communications

Resources related to member communication and audit logs.

List Communications
Sargon clients only - Available upon request

List Comunications

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

sort

string

Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

communicationType

string

Filter by Communication Type

Responses

200 - Communication Collection Response

attachments

array

Array of Attachments attached to this communication

communicationType

string

conversation

array

Array of Conversations attached to this communication

created

string

Resource creation date/time in ISO 8601 format.

hasAttachements

boolean

hasUnread

boolean

isVisibleToMember

boolean

requireFollowUp

boolean

Requested a followup.

subject

string

Subject of this Communications

updated

string

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/communications
Example response: 200 - Communication Collection Response
[ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Create New Communication
Sargon clients only - Available upon request

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Request body

requireFollowUp

boolean

Requested a followup.

subject

string

Subject of this Communications

html_body

string

Body of this communication in plain text.

text_body

string

Body of this communication in plain text.

Responses

200 - Communication Resource Response

attachments

array

Array of Attachments attached to this communication

communicationType

string

conversation

array

Array of Conversations attached to this communication

created

string

Resource creation date/time in ISO 8601 format.

hasAttachements

boolean

hasUnread

boolean

isVisibleToMember

boolean

requireFollowUp

boolean

Requested a followup.

subject

string

Subject of this Communications

updated

string

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/communications
Example request:
{ "requireFollowUp": true, "subject": "string", "html_body": "string", "text_body": "string" }
Example response: 200 - Communication Resource Response
{ "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Communication Details
Sargon clients only - Available upon request

Get Communication Detail

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

communication

string

Unique UUID of the Communication.

Responses

200 - Communication Collection Response

attachments

array

Array of Attachments attached to this communication

communicationType

string

conversation

array

Array of Conversations attached to this communication

created

string

Resource creation date/time in ISO 8601 format.

hasAttachements

boolean

hasUnread

boolean

isVisibleToMember

boolean

requireFollowUp

boolean

Requested a followup.

subject

string

Subject of this Communications

updated

string

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/communications/{communication}
Example response: 200 - Communication Collection Response
[ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Update Communication
Sargon clients only - Available upon request

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

communication

string

Unique UUID of the Communication.

Request body

html_body

string

Body of this communication in plain text.

text_body

string

Body of this communication in plain text.

Responses

200 - Communication Resource Response

attachments

array

Array of Attachments attached to this communication

communicationType

string

conversation

array

Array of Conversations attached to this communication

created

string

Resource creation date/time in ISO 8601 format.

hasAttachements

boolean

hasUnread

boolean

isVisibleToMember

boolean

requireFollowUp

boolean

Requested a followup.

subject

string

Subject of this Communications

updated

string

Resource last updated date/time in ISO 8601 format.

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/communications/{communication}
Example request:
{ "html_body": "string", "text_body": "string" }
Example response: 200 - Communication Resource Response
{ "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Upload Communications Attachment
Sargon clients only - Available upon request

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

communication

string

Unique UUID of the Communication.

Responses

201 - Created
400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/communications/{communication}/upload
Example response: 201 - Created
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Fund Search & Rollover

Fund search & rollover provides the ability to find and consolidate funds from other fund providers.

Fund Search resources represent the results from Fund Search which may be consented to for rollover into the members account.

Fund Details Lookup
Sargon clients only - Available upon request

Lookup Fund Information for Australian Super products and funds.

This can be used for validating/verifying fund details before creating a manual rollover request.

Authorization

Integration
Scope: https://api.sargon.com/integration

Query Parameters

q

string

Collection Quick Search String.

"Quick Search" provides an easy to utilise multiple-attribute search mechanism. The fields searched by quick search vary depending

upon the resource type.

A quick search on Members MAY query the givenName, alternativeName, familyName and email attributes. A quick search on Funds MAY query the fund name, ABN, USI and product names.

Responses

200 - Fund Collection

display

string

fundBusinessIdentifier

string

fundIdentifier

string

productName

string

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/funds
Example response: 200 - Fund Collection
[ { "display": "string", "fundBusinessIdentifier": "string", "fundIdentifier": "string", "productName": "string" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Perform Fund Search

Perform a new Fund Search for the current member.

HTTP Status 403 (Forbidden) will be returned by the API if the Fund Search call is made before member's identity has been verified.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

202 - Standard response

data

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/fundsearch
Example response: 202 - Standard response
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" } }
Example response: 401 - Unauthorized
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Fund Search Result

Return Fund Search results for the specified fundsearch ID.

Status 204 will be returned if fund search results are not available yet.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

fundsearchid

string

Unique UUID of the Fund Search

Responses

200 - Fund Search Operation

data

object

204 - Empty Body
401 - Unauthorized

errors

array

required

404 - Forbidden/Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/fundsearch/{fundsearchid}
Example response: 200 - Fund Search Operation
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "funds": [ { "accountBalance": [ { "amount": 100.1, "currency": "AUD" } ], "accountNumber": "109739", "activityStatus": "Open And Not Lost", "canRollover": true, "definedBenefit": false, "friendlyFundName": "RETIREMENT FUND A", "fundABN": "34090444518", "fundName": "THE TRUSTEE FOR RETIREMENT FUND A", "fundPhone": "0342345699", "insurance": true, "inwardRollover": true, "rolloverStatus": "None", "uniqueSuperIdentifier": "34090444518001" } ], "status": "success", "unclaimedMoneys": [ { "amount": [ { "amount": 100.1, "currency": "AUD" } ], "id": 0, "typeOfFund": "SuperCoContributions" } ] } }
Example response: 204 - Empty Body
Example response: 401 - Unauthorized
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Consent to Fund Search Rollover

The Fund Search Consent process provides a convenience method for creating a Rollover Request.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

fundsearchid

string

Unique UUID of the Fund Search

Query Parameters

onHold

boolean

When true, all consents created will be set to "on hold"

Responses

200 - Standard response

data

object

400 - Bad Request

errors

array

required

404 - Forbidden/Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/fundsearch/{fundsearchid}/consent
Example response: 200 - Standard response
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 404 - Forbidden/Not Found
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
List Rollover Requests
Sargon clients only - Available upon request

List Member's Rollover Requests, including those created with a fund search consent.

Authorization

Integration
Scope: https://api.sargon.com/integration

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

status

string

Show Rollover Requests with the specified status.

Responses

200 - Rollover Collection Response

data

array

400 - Bad Request

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/rollovers
Example response: 200 - Rollover Collection Response
{ "data": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "dateInitiated": "2019-05-10", "fundName": "string", "rolloverType": "SuperSearchConsent", "status": "Failed", "transferAmount": { "amount": 100.1, "currency": "AUD" } } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Create Manual Rollover Request

Allows the creation of an arbitary Rollover Request.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Query Parameters

onHold

boolean

When true, all consents created will be set to "on hold"

Request body

funds

array

List of Funds to be consented to rollover.

rolloverUnclaimedMoneys

boolean

If true, create rollover consent for all unclaimed moneys.

Responses

201 - Created

data

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/rollovers
Example request:
{ "funds": [ { "transferAmount": { "amount": 100.1, "currency": "AUD" }, "accountNumber": "string", "fundABN": "string", "uniqueSuperIdentifier": "string" } ], "rolloverUnclaimedMoneys": true }
Example response: 201 - Created
{ "data": { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Reports
Get Balance
Sargon clients only - Available upon request

Returns the total assets of a fund at a point in time. The total is returned as an amount, with a specified currency.

A date range may be specified to return two or more totals.

Authorization

Integration
Scope: https://api.sargon.com/integration

Query Parameters

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

Responses

200 - Balance Report Collection

data

array

400 - Bad Request

errors

array

required

429 - Rate Limited

errors

array

required

GET
https://api.sargon.com/v1/reports/balance
Example response: 200 - Balance Report Collection
{ "data": [ { "balance": { "amount": 100.1, "currency": "AUD" }, "effectiveDate": "2017-01-31T21:00Z" } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 429 - Rate Limited
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Members
Sargon clients only - Available upon request

Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.

A date range may be specified to return two or more totals.

Authorization

Integration
Scope: https://api.sargon.com/integration

Query Parameters

date

string

Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

A Range can be specified separated by a comma in the form of date=start_date,end_date

If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

Examples:

  • 2016-01-01 - Single day date range covering the date 2016-01-01 only
  • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
  • ,2016-01-01 - All dates up to and including 2016-01-01
  • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
  • ,today - All dates up to and including todays date
  • today, - All dates from and including todays date

p

integer

Pagination Page Number

i

integer

Pagination Page Size (number of entries per page)

o

integer

Pagination Starting Offset

Responses

200 - Member Report Collection

data

array

400 - Bad Request

errors

array

required

429 - Rate Limited

errors

array

required

GET
https://api.sargon.com/v1/reports/members
Example response: 200 - Member Report Collection
{ "data": [ { "effectiveDate": "2017-01-31T21:00Z", "members": { "active": 31000, "inactive": 2502 } } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 429 - Rate Limited
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
OTP

One Time Password (OTP) related operations.

Request Member OTP

Request a One Time Password (OTP) to be sent to the Member. The OTP is valid for authenticating one nominated request and will expire in 10 minutes.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - OTP Resource

data

401 - Unauthorized

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/otp
Example response: 200 - OTP Resource
{ "data": { "expires": "2019-05-10T01:26:47Z", "type": "sms" } }
Example response: 401 - Unauthorized
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Verify Member OTP

Verify a One Time Password (OTP). The OTP is valid for authenticating one nominated request and will expire in 10 minutes.

Authorization

AuthenticatedUser
Scope: https://api.sargon.com/member

Path parameters

member

string

Unique UUID of the Member.

A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

Responses

200 - OTP Verify Resource

data

401 - Unauthorized

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/otp/verify
Example response: 200 - OTP Verify Resource
{ "data": { "expires": "2019-05-10T01:26:47Z" } }
Example response: 401 - Unauthorized
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
WebHooks

Pre-defined callbacks to fund-based integration and notification systems.

Copyright © Sargon 2018  

Terms|Privacy