Default Activate

This guide explains the Default Activate capability, which lets your fund keep the employers that already use you as their default super fund when those employers move to a new HR or payroll platform.

About Default Activate

Default Activate recognises employers that already use your fund as their default. When an employer opens the employer embed in a partner platform - the point at which they configure their default super fund - SuperAPI checks each linked fund for an existing relationship with that employer. If a match comes back, your fund is presented as the employer's existing default and they are prompted to confirm it in a single step, rather than searching for your fund among the full directory.

Default Activate enables your fund to:

1. Keep existing default-fund relationships when employers move between HR or payroll platforms.
2. Confirm an existing relationship in one click rather than having the employer hunt for your fund among hundreds.
3. Collect employer details at the point of confirmation that support ongoing outreach and account management.

The core requirement is a way to tell SuperAPI which employers you already have a default-fund relationship with. This can be done via a live lookup API or by supplying a periodic file of employer ABNs.

WARNING

Only include employers you know you have a current default-fund relationship with. Over-matching surfaces relationships that don't really exist, which damages trust with the employer and with us.

WARNING

Default Activate can only be used with a MySuper product, as employer default funds must always be a MySuper product.

INFO

Looking to win new employer default relationships? See Default Win.

Customising the marketing material

When your fund is presented to an employer as their existing default, you can supply marketing material tailored to that moment - copy, imagery, and any supporting collateral that reinforces the existing relationship.

The same option is available on Default Win, so you can present different material to employers being retained versus employers being won. Supply your marketing material as part of project setup and our design team will configure it in the embed.

Integration paths

Method	Who builds it	Key tasks	Typical effort
Employer lookup API	Super fund	Expose HTTPS endpoint, implement auth, return match result in real time	Medium - requires development effort
Pre-shared list (offline)	Super fund supplies data. SuperAPI takes care of lookups	Export employer ABNs to CSV, deliver via SFTP on agreed schedule	Low - can often be implemented by just your data team

TIP

The pre-shared list is the fastest path to going live. A live API keeps the data fresh and removes the weekly batch window. If you can support both, we suggest starting with a pre-shared list to get into production quickly and moving to a live API later.

Data used for matching

SuperAPI sends the employer's ABN. Matching is performed on ABN only.

Field	Suitability	Notes
abn	Required	Australian Business Number. Uniquely identifies the employer.

Details collected from the employer at confirmation

Before locking in your fund as the employer's default, the embed can ask the employer for additional information that supports your ongoing outreach. The fields are configurable per fund. Common choices include:

• Industry or industry classification
• Number of employees
• Primary contact name
• Primary contact email
• Primary contact phone number
• Best time to contact
• Any custom questions you want to ask

INFO

This is likely the same set of fields you collect via Default Win, though the two can be configured independently.

How collected details are delivered to your fund

The employer details captured at confirmation can be delivered to your fund in one of two ways:

• By SFTP - delivered as a periodic file to an account we provision for you.
• By API call - posted to an endpoint you expose. This is a separate endpoint from the employer lookup API described above, and from any member lookup you may have built for Retain.

We agree the delivery method with you during project setup. You only need to support one.

High-level flows

API flow

Endpoint

The endpoint URL is yours to design. The examples below assume a pattern of:

POST /v1/employer_lookup
Content-Type: application/json

Required headers

These depend on the auth flow that is agreed. Our preference is JWT generated from pre-shared keys; OAuth 2 is also supported.

Header	Notes
X-Auth-Key	API key

Successful response

{
  "employer_found": true,
  "employer_details": {
    "employer_number": "EMP-12345"
  }
}

employer_number is optional. If you return it, SuperAPI will prefill it into the employer's record on your behalf.

No match response

{
  "employer_found": false
}

Error handling

Status	When to use	Retry guidance
400	Malformed JSON or failed validation	No retry
401 / 403	Authentication failed	No retry until credentials fixed
429	Rate limit exceeded	Retry after Retry-After seconds
5xx	Temporary server issue	SuperAPI will retry with exponential back-off up to 3 times

Security and compliance

• Transport: all traffic must use TLS 1.2+.
• Authentication: we support many authentication flows; our preference is JWT generated from pre-shared keys.

Versioning and change control

• The API is versioned via the URL, e.g. /v1/employer_lookup.
• Backwards-compatible changes are announced at least 30 days in advance.
• Breaking changes require 90 days notice.

Pre-shared list flow

If you don't have a live employer lookup API, you can supply a periodic file of employer ABNs and let SuperAPI perform the lookups against it. The match behaviour is identical to the API flow.

File format

• CSV, one row per employer
• Delivered by SFTP to an account we provision for you
• Updated at most once per week

Column	Required	Notes
abn	Yes	Plain ABN, or its SHA-256 hash (see below).
employer_number	No	Optional employer reference. If supplied, SuperAPI will prefill it into the employer's record when a match is confirmed.

ABN hashing

ABNs may be supplied in plain text or hashed with SHA-256. Hashing keeps the file confidential at rest if it is intercepted, at the cost of some operational complexity (you cannot inspect the file directly).

If you choose to hash, you may also agree a pre-shared salt with us in advance. The salt is concatenated with the ABN before hashing:

hashed_abn = sha256(salt + abn)

Get in touch with us to agree the salt before sending your first file.

Getting help

Stuck with something and need help? Please contact us at support@superapi.com.au or by phone on 0405 472 748 (Sam). Have you setup a shared Slack or Teams channel with us? If not, please reach out so we can provide realtime support.