List of Workflow Slugs

This document lists out the workflow slugs that are available to partners.

Workflow slugs are used to identify a particular workflow in the system. Each workflow has a set of modules that users move through.

While we have some standard workflows that are listed out here, we do offer partners the option of creating custom workflows. If you are interested in creating a custom workflow beyond what you can see here, please reach out to us.

Standard Workflow

The standard SuperAPI onboarding workflow uses the standard_onboarding slug. It takes the employee through the tax details (TFN declaration), bank accounts and superannuation choice modules, with the super disclaimer shown before the choice. Modules such as identity, document uploads and fair work statements are not part of this slug; ask us for a custom workflow if you need them.

For partners who have been provided with a custom workflow slug, you do not need to use this slug.

Update Workflows

SuperAPI offers the ability for partners to allow users to update various details via our Embeds. To facilitate this process, we have created a set of 'update' slugs that are designed to allow users to modify existing details.

For each of these, we expect that partners will create the onboarding session with as much information as possible (i.e. from previously completed onboarding sessions) for the relevant workflow. Because we pre-fill as much as possible this will provide users with a better 'update' experience.

These update slugs are:

1. tfnd_only - Allows users to modify and re-submit their TFN declaration.
2. bank_accounts_only - Allows users to enter their bank account/s.
3. phone_and_super - Allows users to update their superannuation details. Despite the name, this slug contains no phone verification step, only the super disclaimer and superannuation choice.
4. phone_tax_super - The TFN declaration followed by the super disclaimer and superannuation choice, for partners that capture bank accounts in their own system.

While these are termed 'update slugs', they are not fundamentally different to any of our standard workflows. They are simply limited to fewer modules.