Continuous Access
Continuous access to payroll data & functionality is achieved through a concept we refer to as Linked Accounts. Once enabled, a user’s payroll account is linked to Atomic, allowing you to interface with it and receive ongoing updates to data.
Use Cases
- 💼 Monitoring for adjustments to employment & income.
- 💸 Monitoring for changes to a user’s direct deposit distribution.
- 🗓 Retrieving new paystubs & timesheets.
- 🔒 Monitoring for adjustments to a user’s identity information.
Push Strategy
Atomic will periodically refresh a user’s payroll data and proactively push updates to your designated webhook endpoint.
Webhook Events
deposit-switch-removed | A deposit switch that was previously added has now been removed. |
statements-synced | Statement(s) were synced. |
statements-added | Statement(s) were added. |
income-synced | Income data was synced. |
income-updated | Income data was updated. |
timesheets-synced | Timesheet(s) were synced. |
timesheets-added | Timesheet(s) were added. |
employment-synced | Employment data was synced. |
employment-updated | Employment data was updated. |
identity-synced | Identity data was synced. |
identity-updated | Identity data was updated. |
taxes-synced | Tax data was synced. |
taxes-added | Tax data object(s) were added. |
deposit-accounts-synced | Deposit account(s) were synced. |
deposit-accounts-added | Deposit account(s) were added. |
deposit-accounts-updated | Deposit account(s) were updated. |
deposit-accounts-removed | Deposit account(s) were removed. |
linked-account-connected | A linked account has been connected. |
linked-account-disconnected | A linked account has become disconnected. |
task-workflow-finished | The workflow for the user either has completed or failed - includes a failure reason. |
Pull Strategy
Data can also be refreshed, and retrieved on-demand. Data can be pulled using the following steps:
1
Use our List Linked Accounts endpoint to locate an account for which you’d like to pull data.
2
Pass the
linkedAccountId
to our task creation endpoint to issue a refresh of the associated data.3
Once you receive a
task-status-updated
event indicating that the task status iscompleted
, use our API endpoints to retrieve the latest data, or subscribe to our employment data webhook events.
Endpoints
All endpoints require an identifier
parameter and can optionally be filtered by linkedAccount
.
GET /linked-accounts | List linked accounts. |
GET /income | Get income data. |
GET /statements | List all statements. |
GET /deposit-accounts | List deposit accounts. |
GET /employment | Get employment data. |
GET /taxes | Get tax data. |
GET /identity | Get identity data. |
GET /timesheets | List timesheets. |
Reconnecting Accounts
Occasionally, an account’s connection may be interrupted due to timeout restrictions, changes to credentials, or system updates. When an interruption is encountered, you’ll receive a linked-account-disconnected
event.
Reestablishing connectivity is easy
Our Transact SDK can be used to reconnect an account that has encountered an interruption. By implementing the linkedAccount
parameter of our SDK, the user can access the authentication flow directly, which will often not require the user to re-enter their credentials.