API product
Using this API product
API list
Release notes

SMSF Alias Lookup API

You can use the SMSF alias lookup API to verify the details of a self-managed super fund (SMSF) alias and its associated gateway.
Last modified
Status
Active
Risk rating
1 - no risk

Using this API product

Description

You can use the SMSF alias lookup API to verify the details of a self-managed super fund (SMSF) alias and its associated gateway.

If you are an entity that is responsible for sending contribution and rollover messages to SMSFs in the SuperStream Standard (for example, clearing houses or other gateways providers), you can use this API to ensure the SMSF alias details are correct.

A mandatory step for setting up an SMSF is to get an electronic service address.

Back to top

API risk rating

1 - No risk

For more information, see API risk rating.

Back to top

Authentication

See: M2M client authentication.

Back to top

Scopes

ato.smsfaliaslookup.providers.r

Back to top

Rate Limit

Not applicable.

Back to top

Production requirements

Before you can request production access for this API, you must meet the requirements for production access.

API List

SMSF alias lookup API

This API returns a list of SMSF message providers

This API has the following endpoints:

  • GET / Use this endpoint to get the current version and status of the SMSF Alias Lookup API.
  • GET /specs/yaml Use this endpoint to view the SMSF Alias Lookup API in YAML format.
  • GET /specs/spec.yaml Use this endpoint to download the SMSF Alias Lookup API in YAML format.
  • GET /providers Use this endpoint to get the full list of SMSF Alias messaging providers

API specification

Release notes

Republishing the API Product Page. 

Last Modified 12/09/2023