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

First you will need some API Keys for your application. You can create and manage your API keys in the Developers section of your account. Your API credentials carry many privileges, so be sure to keep them secure! Do not share your secret keys in publicly accessible areas such GitHub, client-side code, and so forth.

Once you have some credentials you can use one of the authentication methods listed below.

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.

For more information see the documentation

Unauthenticated Access

Some endpoints may be accessed without first verifying the user's identity. An example is Create Member used during onboarding. For these endpoints you send your application credential Client ID in the request as header X-Api-Key

The format of the request header is:

X-Api-Key: [Client ID]

User Authentication

AuthenticatedUser authentication is for requests representing a user and requires valid user credentials.

The user credentials are exchanged for an OAuth 2 token with appropriate scopes and is used for all subsequent requests to the API for this session.

Available scopes:

  • https://api.sargon.com/member

Integration Authentication

Integration authentication is for System to System API usage. Integration level access tokens can only be requested using a backend application and client_credentials OAuth flow.

Available scopes:

  • https://api.sargon.com/integration

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

Most 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.

The are multiple OTP scopes that can be obtained depending on the endpoint you wish to access. Each endpoint will detail the scope required. In general you will request a read OTP when the member first logs in, which will give read access for the duration of the session. If the member wishes to perform a more privileged operation, such as updating their details, an additional write otp can be requested.

OTP scopes:

  • read - provides limited access and once verified will be valid for the duration of the current member session.
  • write - provides full access but will expire 10 minutes after verification.

When an OTP is required the client can request one using the /members/:memberId/otp endpoint and specifying the required scope. 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.

Verifying OTP codes:

Once the user has provided the code there are 2 options for verification:

  • Explicitly verify the code by calling the /members/:memberId/otp/verify endpoint. This will return details of the OTP session.
  • Send the desired request and specify the code in the X-Super-OTP request header. The OTP code will be verified and the request performed as normal.

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.

Events

Events represent important things that occur in your fund. When an important event occurs we record the facts in an Event object. Some examples are when a member is created, or when a rollover is completed.

An event represents the state of the resource at the point in time that the event occurred.

You can use the list recent events endpoint to retrieve a list of recent events that have occurred within your fund. More event related endpoints will be added over time.

You can also setup event 'listeners' to receive information about events in near real-time. This is via Webhooks. A Webhook allows you to receive event data directly on an endpoint on your server.

The Event object attributes:

Attribute

Description

id

the UUID of the event

type

the name of the event type

mode

either sandbox or live

created

the date the event was created

data

Object that contains the data that is specific to the event type

TYPES OF EVENTS

This is a list of the currently supported types of events. More will be added in the short term.

Event

Description

member.created

This occurs when a new member is created

rollover.received

This occurs when a rollover is received

contribution.received

This occurs when a contribution is received

Webhooks

You can configure a webhook that defines an HTTPS endpoint on your server that will send event related information in near real-time.

Your endpoint must be protected by SSL and the SSL certificate must be valid. Each webhook has a signing secret that we use create a signature which we include in the webhook payload. This allows you to verify that the webhook payload can be trusted.

We POST a payload to your endpoint and include the following important HTTP headers:

Header

Description

x-super-signature

The timestamp the message was sent in seconds since epoch.

x-super-timestamp

The computed HMAC SHA-256 of signed payload. The signed payload is `[x-super-signature].[request body]`

For example, your server code can verify the message by concatenating x-super-signature, a full stop, and the request body; then computing the HMAC; then asserting that the computed HMAC matches the signature (x-super-signature).

Note: when the signing secret is regenerated it is possible to delay the expiry of the current secret to allow time to update your server endpoints. In this case, the will be multiple signatures in x-super-signature.

If your server endpoint returns an error, the webhook will retry a maximum of 20 times.

We advise that your server endpoint be designed to return a 200 response as soon as possible. If your endpoint performs potentially long running operations (e.g. connecting to other systems, sending email, etc) then these should ideally be executed asynchronously. Webhooks will wait no longer than 20 seconds for a response - at which point we will assume a failure and schedule a retry attempt.

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

401 - Unauthorized

errors

array

required

404 - 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", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "memberStatus": "Active", "suburb": "string" } ] }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

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.

id

string

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

addressPostal

object

Postal Address

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

gender

string

Gender of the person.

memberStatus

string

Membership Status. The specific membership status and meanings utilised may vary on a fund by fund basis.

phoneMobile

string

required

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

password

string

Password of the member to login.

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

201 - Member Created Resource

data

object

Member Resource

links

object

meta

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

409 - Conflict - The email address has already been used

errors

array

required

POST
https://api.sargon.com/v1/members
Example request:
{ "familyName": "Doe", "givenName": "John", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "addressPostal": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "addressResidential": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "birthDate": "1967-**-**", "email": "john@test.com", "gender": "Male", "memberStatus": "Active", "phoneMobile": "+61412345678", "password": "pa$$word", "taxId": "430 *** ***" }
Example response: 201 - Member Created Resource
{ "data": { "familyName": "Doe", "flagInsured": true, "flagIsContributor": true, "givenName": "John", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressPostal": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "addressResidential": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "birthDate": "1967-**-**", "email": "john@test.com", "gender": "Male", "idVerificationStatus": "Validated", "memberStatus": "Active", "phoneMobile": "+61412345678", "taxIdStatus": "Supplied" }, "links": { "self": "string" }, "meta": { "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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 409 - Conflict - The email address has already been used
{ "errors": [ { "code": "string", "detail": "string", "source": { "pointer": "string" }, "status": "404" } ] }
Get Member

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

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

MEMBER OTP REQUIRED

scope: read

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

Member Resource

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - 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", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressPostal": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "addressResidential": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "birthDate": "1967-**-**", "email": "john@test.com", "gender": "Male", "idVerificationStatus": "Validated", "memberStatus": "Active", "phoneMobile": "+61412345678", "taxIdStatus": "Supplied" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Update Member

Update or perform an operation on a Member resource.

Once a member has been identity verified some attributes will become readOnly. For an identity verified member, only these properties are updatable: addressPostal, addressResidential.

In the case where the API detects no changes between the update request and current member details, the API will return a HTTP 200 status.

A valid OTP session with write scope is required to perform this operation.

When accessed using member scope, this operation is limited to the currently authenticated member.

Authorization

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

MEMBER OTP REQUIRED

scope: write

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

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.

familyName

string

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

gender

string

Gender of the person.

givenName

string

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

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

Member Resource

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}
Example request:
{ "addressPostal": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "addressResidential": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "birthDate": "1967-**-**", "familyName": "Doe", "gender": "Male", "givenName": "John", "taxId": "430 *** ***" }
Example response: 200 - Member Resource
{ "data": { "familyName": "Doe", "flagInsured": true, "flagIsContributor": true, "givenName": "John", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressPostal": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "addressResidential": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "birthDate": "1967-**-**", "email": "john@test.com", "gender": "Male", "idVerificationStatus": "Validated", "memberStatus": "Active", "phoneMobile": "+61412345678", "taxIdStatus": "Supplied" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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-11-20T03:50:31Z", "eventCode": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "initiatedBy": "Member", "status": "Pending", "timeComplete": "2019-11-20T03:50:31Z", "timeStart": "2019-11-20T03:50:31Z" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Get Member's account balance

Returns an account balance summary of a member.

Authorization

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

MEMBER OTP REQUIRED

scope: read

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 Balance Resource

data

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/balance
Example response: 200 - Member Balance Resource
{ "data": { "closingBalance": { "amount": 10010, "currency": "AUD" }, "contribution": { "amount": 10010, "currency": "AUD" }, "fee": { "amount": 10010, "currency": "AUD" }, "from": "2014-10-01", "income": { "amount": 10010, "currency": "AUD" }, "insurance": { "amount": 10010, "currency": "AUD" }, "openingBalance": { "amount": 10010, "currency": "AUD" }, "tax": { "amount": 10010, "currency": "AUD" }, "to": "2014-12-31" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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.

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

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/contacts
Example response: 200 - Contact Collection Response
[ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "contactType": "Advisor", "created": "2017-01-31T21:00Z", "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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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 all beneficiaries

List all beneficiaries for the member specified by member ID. Note: Currently we are unable to return the beneficiaries' addresses.

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 - Beneficiary response

data

array

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries
Example response: 200 - Beneficiary response
{ "data": [ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "beneficiaryType": "non_binding", "benefitProportion": 100, "birthDate": "1980-01-31", "familyName": "Doe", "givenName": "John", "relationship": "aunt" } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Create a beneficiary intent

Submit beneficiary intent. HTTP Status 400 (Bad Request) will be returned by the API if the Update call is made on a Binding Beneficiary

Authorization

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

MEMBER OTP REQUIRED

scope: write

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

beneficiaries

array

Responses

201 - Beneficiary intent response

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/beneficiaries/intents
Example request:
{ "beneficiaries": [ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "beneficiaryType": "non_binding", "benefitProportion": 100, "birthDate": "1980-01-31", "familyName": "Doe", "givenName": "John", "relationship": "aunt" } ] }
Example response: 201 - Beneficiary intent response
{ "data": { "beneficiaries": [ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "beneficiaryType": "non_binding", "benefitProportion": 100, "birthDate": "1980-01-31", "familyName": "Doe", "givenName": "John", "relationship": "aunt" } ], "created": "2017-01-31T21:00Z", "id": "string", "updated": "2017-01-31T21:00Z" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Retrieve the latest beneficiary intent

Retrieve the latest beneficiary intent for the member specified by member ID.

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 - Beneficiary intent response

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries/intents/latest
Example response: 200 - Beneficiary intent response
{ "data": { "beneficiaries": [ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "beneficiaryType": "non_binding", "benefitProportion": 100, "birthDate": "1980-01-31", "familyName": "Doe", "givenName": "John", "relationship": "aunt" } ], "created": "2017-01-31T21:00Z", "id": "string", "updated": "2017-01-31T21:00Z" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Retrieve a beneficiary intent

Retrieve the beneficiary intent with the given ID.

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.

beneficiaryIntentId

string

Unique UUID of the Beneficiary Intent.

Responses

200 - Beneficiary intent response

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/beneficiaries/intents/{beneficiaryIntentId}
Example response: 200 - Beneficiary intent response
{ "data": { "beneficiaries": [ { "address": { "countryCode": "AU", "line1": "123 Swanston St", "line2": "Unit 7", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "beneficiaryType": "non_binding", "benefitProportion": 100, "birthDate": "1980-01-31", "familyName": "Doe", "givenName": "John", "relationship": "aunt" } ], "created": "2017-01-31T21:00Z", "id": "string", "updated": "2017-01-31T21:00Z" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Investments

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

Change Investments
Sargon clients only - Available upon request

Update member's investments and future cash allocations.

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

If member has holdings in their investments, the API will respond with a HTTP 202 Accepted status and schedule the request to investment administrator.

Authorization

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

MEMBER OTP REQUIRED

scope: write

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

id

string

required

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

percent

number

required

Percentage to allocate

Responses

200 - Investments Resource Collection Response

data

object

202 - Standard response

data

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/investments
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 100 } ]
Example response: 200 - Investments Resource Collection Response
{ "data": { "balance": [ { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "buyPrice": { "amount": 10010, "currency": "AUD" }, "canBuy": true, "canSell": true, "investmentDescription": "string", "investmentType": "string", "sellPrice": { "amount": 10010, "currency": "AUD" }, "units": "string", "valuation": { "amount": 10010, "currency": "AUD" } } ], "futurecash": [ { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 100 } ] } }
Example response: 202 - Standard response
{ "data": { "created": "2017-01-31T21:00Z", "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": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
List Investments Balance

List investments balance information for the specified member.

Authorization

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

MEMBER OTP REQUIRED

scope: read

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 Balance Collection Response

data

array

links

object

meta

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/balance
Example response: 200 - Investment Balance Collection Response
{ "data": [ { "buyPrice": { "amount": 10010, "currency": "AUD" }, "canBuy": true, "canSell": true, "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "investmentDescription": "string", "investmentType": "string", "sellPrice": { "amount": 10010, "currency": "AUD" }, "units": "string", "valuation": { "amount": 10010, "currency": "AUD" } } ], "links": { "self": "string" }, "meta": { "count": 0, "offset": 0, "total": 0 } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Request Investment Rebalance / Transfer
Sargon clients only - Available upon request

Change member's current investments. The API accepts percentage based rebalance or amount based transfer. Either percent OR transferAmount field must be present in the request.

For percentage based rebalance, a representation of all allocations must be included in the request. The sum of all percentages specified MUST equal 100.

For amount based transfer, the "source" and "destination" investments must be specified in the request. Negative amount should be used for "source" investment. The sum of all amounts specified MUST equal 0.

A valid OTP session with write scope is required to perform this operation.

API will respond with HTTP 202 Accepted status and schedule the update request with the investment administrator.

Example

// Percent based
[
  {
    "id": "investment option UUID",
    "percent": 60
  },
  {
    "id": "investment option UUID",
    "percent": 40
  }
]

// Amount based
[
  {
    "id": "source investment option UUID"
    "transferAmount": {
      "amount": -10000,
      "currency": "AUD"
    }
  },
  {
    "id": "destination investment option UUID"
    "transferAmount": {
      "amount": 10000,
      "currency": "AUD"
    }
  }
]

Authorization

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

MEMBER OTP REQUIRED

scope: write

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

id

string

required

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

percent

number

Percentage to allocate

transferAmount

object

A money object with a specific currency in ISO 4217 format and an amount, where the amount is given in the smallest denomination of the given currency. For example, when the currency is AUD, the amount is provided in cents.

Responses

202 - Request Accepted

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/investments/balance
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 100, "transferAmount": { "amount": 10010, "currency": "AUD" } } ]
Example response: 202 - Request Accepted
{ "data": { "description": "Your update request has been accepted", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
List Future Cash Allocations

Get most recent future cash allocations

Authorization

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

MEMBER OTP REQUIRED

scope: read

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 Cash Allocation Collection Response

data

array

links

object

meta

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/futurecash
Example response: 200 - Investment Cash Allocation Collection Response
{ "data": [ { "displayName": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "key": "string", "percent": 100 } ], "links": { "self": "string" }, "meta": { "count": 0, "offset": 0, "total": 0 } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Update Future Cash Allocations

Update member's investment future cash allocations.

This Resource accepts a JSON array of InvestmentAllocation Resources which each contain a 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.

A valid OTP session with write scope is required to perform this operation.

A successful request will return a 200 OK status and include the updated future cash allocations.

If the update cannot be performed immediately the API will respond with a HTTP 202 Accepted status and schedule the update request with the investment administrator.

Authorization

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

MEMBER OTP REQUIRED

scope: write

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

id

string

required

Investment option UUID

percent

number

required

Percentage allocated to this investment

Responses

200 - Investment Cash Allocation Collection Response

data

array

links

object

meta

202 - Request Accepted

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/investments/futurecash
Example request:
[ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 100 } ]
Example response: 200 - Investment Cash Allocation Collection Response
{ "data": [ { "displayName": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "key": "string", "percent": 100 } ], "links": { "self": "string" }, "meta": { "count": 0, "offset": 0, "total": 0 } }
Example response: 202 - Request Accepted
{ "data": { "description": "Your update request has been accepted", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
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

MEMBER OTP REQUIRED

scope: read

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 - Historic Cash Allocation Collection Response

allocations

array

effectiveDate

string

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/futurecashhistory
Example response: 200 - Historic Cash Allocation Collection Response
[ { "allocations": [ { "displayName": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "key": "string", "percent": 100 } ], "effectiveDate": "2019-11-20" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
List 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

MEMBER OTP REQUIRED

scope: read

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

links

object

meta

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/options
Example response: 200 - Investment Options Collection Response
{ "data": [ { "description": "string", "displayName": "string", "frozen": true, "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "key": "string", "legacy": true } ], "links": { "self": "string" }, "meta": { "count": 0, "offset": 0, "total": 0 } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Get 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

series

array

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/investments/performance
Example response: 200 - FUM Graph Data
{ "series": [ { "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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: read

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

401 - Unauthorized

errors

array

required

404 - 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", "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" }, "coverName": "string", "coverType": "string", "status": "PENDING", "terms": [ "string" ] } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: read

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

401 - Unauthorized

errors

array

required

404 - 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", "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" }, "coverName": "string", "coverType": "string", "status": "PENDING", "terms": [ "string" ] } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: read

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.

cover

string

Unique UUID of the Insurance Cover.

Responses

200 - Insurance Cover Response

data

object

links

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/covers/{cover}
Example response: 200 - Insurance Cover Response
{ "data": { "created": "2017-01-31T21:00Z", "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" }, "coverName": "string", "coverType": "string", "status": "PENDING", "terms": [ "string" ], "covers": [ { "coverAmount": { "amount": 10010, "currency": "AUD" }, "effectiveFrom": "2019-11-20", "effectiveTo": "2019-11-20", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "retail": true, "retailInsurer": "string" } ] }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: write

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.

cover

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

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

PUT
https://api.sargon.com/v1/members/{member}/insurance/covers/{cover}
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", "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" }, "coverName": "string", "coverType": "string", "status": "PENDING", "terms": [ "string" ], "covers": [ { "coverAmount": { "amount": 10010, "currency": "AUD" }, "effectiveFrom": "2019-11-20", "effectiveTo": "2019-11-20", "premiumAmount": { "amount": 10010, "currency": "AUD" }, "premiumPeriod": "monthly", "retail": true, "retailInsurer": "string" } ] }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: write

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.

cover

string

Unique UUID of the Insurance Cover.

Responses

204 - Empty Body
400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

DELETE
https://api.sargon.com/v1/members/{member}/insurance/covers/{cover}
Example response: 204 - Empty Body
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: read

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

401 - Unauthorized

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", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "commencementDate": "2019-11-20", "currentStatus": "AVAILABLE", "description": "string", "policyType": "TPD" } ], "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
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

MEMBER OTP REQUIRED

scope: read

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

401 - Unauthorized

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/insurance/policies/{policy}
Example response: 200 - Insurance Policy Response
{ "data": { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "commencementDate": "2019-11-20", "currentStatus": "AVAILABLE", "description": "string", "policyType": "TPD", "schema": {} }, "links": { "self": "string" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
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

List Transactions.

Defaults to transactions belonging to the currently authenticated member when accessed with member credentials.

Authorization

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

Query Parameters

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

sort

string

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

Responses

200 - Transaction Collection

data

array

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/transactions
Example response: 200 - Transaction Collection
{ "data": [ { "amountIn": 912134, "amountOut": 823421, "coa": "string", "effectiveDate": "2015-01-19T17:50:00.000Z", "id": "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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

401 - Unauthorized

errors

array

required

404 - 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: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

fundBusinessIdentifier

string

fundIdentifier

string

productName

string

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/funds
Example response: 200 - Fund Collection
[ { "fundBusinessIdentifier": "string", "fundIdentifier": "string", "productName": "string" } ]
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: write

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 - Fund Search Operation

data

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/fundsearch
Example response: 202 - Fund Search Operation
{ "data": { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "status": "pending" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Get Latest Fund Search Result

Return the most recent fund search results.

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.

Responses

200 - Fund Search Result

data

object

204 - Empty Body
401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/fundsearch/latest
Example response: 200 - Fund Search Result
{ "data": { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "status": "pending", "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" } ], "unclaimedMoneys": [ { "amount": { "amount": 100.1, "currency": "AUD" }, "typeOfFund": "SuperCoContributions" } ] } }
Example response: 204 - Empty Body
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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 Result

data

object

204 - Empty Body
401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/fundsearch/{fundsearchid}
Example response: 200 - Fund Search Result
{ "data": { "created": "2017-01-31T21:00Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "status": "pending", "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" } ], "unclaimedMoneys": [ { "amount": { "amount": 100.1, "currency": "AUD" }, "typeOfFund": "SuperCoContributions" } ] } }
Example response: 204 - Empty Body
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "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

MEMBER OTP REQUIRED

scope: write

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 - Rollover Request Confirmation Response

data

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

404 - Not Found

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/fundsearch/{fundsearchid}/consent
Example response: 200 - Rollover Request Confirmation Response
{ "data": { "created": "2017-01-31T21:00Z" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
List Rollover Requests

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

Authorization

Integration
scope: https://api.sargon.com/member
Integration
scope: https://api.sargon.com/integration

Responses

200 - Rollover Collection Response

data

object

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/rollovers
Example response: 200 - Rollover Collection Response
{ "data": { "funds": [ { "accountNumber": "string", "created": "2017-01-31T21:00Z", "fundABN": "string", "fundName": "string", "status": "requested", "transferAmount": { "amount": 10010, "currency": "AUD" }, "uniqueSuperIdentifier": "string", "updated": "2017-01-31T21:00Z" } ], "unclaimedMoney": { "created": "2017-01-31T21:00Z", "status": "requested", "updated": "2017-01-31T21:00Z" } } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Create Manual Rollover Request

Allows the creation of an arbitary Rollover Request.

Authorization

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

MEMBER OTP REQUIRED

scope: write

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 - Rollover Request Confirmation Response

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 - Rollover Request Confirmation Response
{ "data": { "created": "2017-01-31T21:00Z" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
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.

After requesting an OTP you have 10 minutes to verify it before it expires.

The scope query parameter should be specified for the desired level of member access:

  • read: provides limited access and once verified will be valid for the duration of the current member session.
  • write: provides full access but will expire 10 minutes after verification.

If not provided, the default scope is read.

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

scope

string

OTP Scope. The level of OTP access required (i.e. read or write)

Responses

200 - OTP Resource

data

400 - Bad Request

errors

array

required

401 - Unauthorized

errors

array

required

POST
https://api.sargon.com/v1/members/{member}/otp
Example response: 200 - OTP Resource
{ "data": { "expires": "2019-11-20T03:50:31Z", "type": "sms" } }
Example response: 400 - Bad Request
{ "errors": [ { "detail": "\"Given Name\" is required", "source": { "pointer": "givenName" } } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Verify Member OTP

Verify a One Time Password (OTP).

If successful the current member will be granted access for the OTP scope requested when creating the OTP.

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-11-20T03:50:31Z" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Documents

Enables the Fund to download various files or reports, such as unit prices or transaction reports, etc.

List Member Documents

List all documents for a member

Authorization

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

MEMBER OTP REQUIRED

scope: read

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 - Document Collection Response

data

array

required

List of documents

links

object

required

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/documents
Example response: 200 - Document Collection Response
{ "data": [ { "description": "string", "documentDate": "2019-11-20T03:50:31Z", "filename": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "type": "string" } ], "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Get Member Document

Get the details for a member document including download link.

The returned download link is a short-lived url with expiry of 30 seconds (expiry populated in urlExpiry property). If you wish to download the document file it is expected that you will call this endpoint and then immediately request or redirect to the download url.

By default the download url will return with a content-disposition header of attachment which will trigger a download in most browsers. If you'd prefer the document to open instead of download you can control this by setting the display query parameter to inline.

Authorization

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

MEMBER OTP REQUIRED

scope: read

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.

document

string

Unique UUID of the Document.

Query Parameters

display

string

Response display option for requested document - e.g. inline vs attachment. This controls the content-disposition header in the response when the document url is fetched. Defaults to attachment.

Responses

200 - Document Response

data

object

required

Document Details

links

object

required

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/members/{member}/documents/{document}
Example response: 200 - Document Response
{ "data": { "description": "string", "documentDate": "2019-11-20T03:50:31Z", "filename": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "type": "string", "url": "string", "urlExpiry": "2019-11-20T03:50:31Z" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Webhooks

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

List all Webhooks
Sargon clients only - Available upon request

Returns a list of your webhooks.

Authorization

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

Responses

200 - Webhook Collection Resource

data

array

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/webhooks
Example response: 200 - Webhook Collection Resource
{ "data": [ { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" } ], "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Create Webhook
Sargon clients only - Available upon request

A webhook must have a url and a list of events

Authorization

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

Request body

enabled

string

The status whether webhook is enabled or disabled.

events

array

required

The list of events to enable for this webhook.

url

string

required

The URL of the webhook.

Responses

201 - Webhook Resource

data

object

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

POST
https://api.sargon.com/v1/webhooks
Example request:
{ "enabled": "string", "events": [ "string" ], "url": "string" }
Example response: 201 - Webhook Resource
{ "data": { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Get Webhook
Sargon clients only - Available upon request

Retrieves the webhook with the given ID.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Responses

200 - Webhook Resource

data

object

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/webhooks/{webhookId}
Example response: 200 - Webhook Resource
{ "data": { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Update Webhook
Sargon clients only - Available upon request

Update the webhook with the given ID. You may edit the url, the list of events, and the enabled status.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Request body

enabled

string

required

The status whether webhook is enabled or disabled.

events

array

required

The list of events to enable for this webhook.

url

string

required

The URL of the webhook.

Responses

200 - Webhook Resource

data

object

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

PUT
https://api.sargon.com/v1/webhooks/{webhookId}
Example request:
{ "enabled": "string", "events": [ "string" ], "url": "string" }
Example response: 200 - Webhook Resource
{ "data": { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Delete Webhook
Sargon clients only - Available upon request

Deletes the webhook with the given ID.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Responses

204 - Empty Body
401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

DELETE
https://api.sargon.com/v1/webhooks/{webhookId}
Example response: 204 - Empty Body
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
List webhook attempts
Sargon clients only - Available upon request

Returns a list of webhooks attempts for a specified webhook.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Responses

200 - Webhook Attempts Collection Resource

data

array

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/webhooks/{webhookId}/attempts
Example response: 200 - Webhook Attempts Collection Resource
{ "data": [ { "created": "2017-01-31T21:00Z", "eventId": "string", "eventType": "string", "httpStatus": 0, "id": "string", "requestBody": "string", "requestHeaders": "string", "responseBody": "string", "responseHeaders": "string", "status": "success", "updated": "2017-01-31T21:00Z", "url": "string" } ] }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Get webhook secret
Sargon clients only - Available upon request

Returns webhook details including the signing secret.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Responses

200 - Webhook Resource

data

object

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

GET
https://api.sargon.com/v1/webhooks/{webhookId}/secret
Example response: 200 - Webhook Resource
{ "data": { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Regenerate webhook secret
Sargon clients only - Available upon request

Regenerates webhook signing secret.

Once regenerated the new signing secret will be used immediately for signing any new webhook notifications.

The existing active signing secret can be expired immediately or delayed for up to 24 hours to allow graceful updates to downstream systems. During this delay period signatures for both secrets will be including in webhook notifications.

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

Request body

expiryHours

integer

required

How long the current signing secret should remain valid for (0-24 hours)

Responses

200 - Webhook Resource

data

object

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

POST
https://api.sargon.com/v1/webhooks/{webhookId}/secret
Example request:
{ "expiryHours": 0 }
Example response: 200 - Webhook Resource
{ "data": { "created": "2017-01-31T21:00Z", "enabled": true, "events": [ "string" ], "id": "string", "secret": "string", "updated": "2017-01-31T21:00Z", "url": "string" }, "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Send Test Webhook Event
Sargon clients only - Available upon request

Send a test event to a webhook endpoint

Authorization

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

Path parameters

webhookId

string

Unique UUID of the Webhook.

eventType

string

Event type.

Responses

200 - Webhook Attempt Response

data

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

404 - Not Found

errors

array

required

POST
https://api.sargon.com/v1/webhooks/{webhookId}/test/{eventType}
Example response: 200 - Webhook Attempt Response
{ "data": { "created": "2017-01-31T21:00Z", "eventId": "string", "eventType": "string", "httpStatus": 0, "id": "string", "requestBody": "string", "requestHeaders": "string", "responseBody": "string", "responseHeaders": "string", "status": "success", "updated": "2017-01-31T21:00Z", "url": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Example response: 404 - Not Found
{ "errors": [ { "detail": "Not found", "status": "404" } ] }
Events
List recent events
Sargon clients only - Available upon request

Returns a list of events occurred in the past 15 days.

Authorization

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

Responses

200 - Event collection response

data

array

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/events
Example response: 200 - Event collection response
{ "data": [ { "created": "2017-01-31T21:00Z", "data": {}, "id": "string", "mode": "string", "type": "string", "updated": "2017-01-31T21:00Z" } ], "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }
Get supported event types
Sargon clients only - Available upon request

Retrieves all supported events for webhooks.

Authorization

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

Responses

200 - Event type collection response

data

array

links

object

401 - Unauthorized

errors

array

required

403 - Forbidden

errors

array

required

GET
https://api.sargon.com/v1/events/types
Example response: 200 - Event type collection response
{ "data": [ "string" ], "links": { "self": "string" } }
Example response: 401 - Unauthorized
{ "errors": [ { "detail": "Unauthorized", "status": "401" } ] }
Example response: 403 - Forbidden
{ "errors": [ { "detail": "Forbidden", "status": "403" } ] }

Copyright © Sargon 2018  

Terms|Privacy