Skip to main content
How users can easily re-authorize their payroll connections.
If you are embedding Link within your website or application, users can be sent directly to an account by including the optional accountId parameter in your Link initialization code.
  • Account ID’s can be retrieved via the API.
  • Account ID’s can also be copied from Console: Click the three vertical dots on an account card after selecting an individual user.
Account IDs can be copied directly from Console.
accountId: "<ID of account>"
If the user is sent to a disconnected account, they will only need to select Reconnect to re-establish the account connection, and will not need to re-enter their login credentials.
Users can reconnect disconnected accounts in one-click without the need to resubmit login credentials.

​
Invites

If the user was originally sent an invite via Console or via the API, the user can return to Link any time using the same URL hyperlink included in the invite, which does not expire.
If the original invite is lost, it can be resent to the user through Console or via the API. Sending a new invite to the same user will result in duplicate users and should not be used to reconnect disconnected accounts.
In Console, invites can be resent by hovering over the user and clicking Resend, or the direct hyperlink can by copied by hovering over Sent by [name] and shared directly with the user.
You can resend invites through the Connections page of Console.
Once the user returns to Link, they will be sent directly to their connections page where they can access their previous connections and take additional actions, including reconnecting a disconnected account (no login credentials required).
The Your connections screen can be initially shown to returning users by editing your Link Flow.

​
Shareable URLs

If a user originally reached Link through a shareable URL, the user can return to Link and access, manage, and reconnect their accounts through the same original URL hyperlink. A copy of the shareable URL associated with an individual user can be found in the Connections page of Console. See the reconnecting users section of our Shareable URLs Guide for more information.

​
Adjusting Link’s initial screen

The following customization is only available for Web implementations of Link.
Returning users can be sent directly to Link’s search page instead of their connections page:
  1. Create or edit an existing Flow in Console.
  2. Toggle OFF the General Setting that says: “Show Your connections as the initial screen for returning users.”
  3. Save the Flow, copy its Flow ID, and include it in your Link initialization using the flowId optional initialization parameter.
Users will still be able to access their previous connections in the upper-right of the search screen to take additional actions, including reconnecting a disconnected account (no login credentials required).
The user can see and enter the currently connected accounts in the upper right of Link's search screen.

​
Why accounts disconnect

Argyle’s platform keeps every payroll connection alive for as long as the associated payroll system allows. Once a user connects a payroll account, the connection stays alive indefinitely whenever possible. This allows Argyle to continuously scan and retrieve any new data that is added to the user’s payroll account, giving you ongoing data refreshes as new paystubs or payroll documents become available.
Similarly to how bank account connections with third party apps need to be refreshed periodically, some payroll systems require users to re-authenticate their connections from time to time. If an account becomes disconnected, payroll data can still be retrieved via Console or the API, but ongoing data refreshing will be paused until the account is reconnected by the user.

​
Types of disconnections

​
Re-authorization needed

Some payroll systems have automatic log-outs after a set period of time. Once Argyle scans a connected payroll system and finds the user has been logged out, both Console and the API will display an auth_required error in the account’s details:
An auth_required error will show in the account's error details, which can be viewed in Console by selecting the three dots within the individual user screen and selecting View account JSON.
  • If a disconnection occurs, have the user return to Link.
  • The user can re-establish the connection by simply selecting Reconnect. No need to re-submit login credentials!
When a user returns to a connecting account in Link, one click of the Reconnect button allows them to re-authorize their account without needing to re-enter their login credentials.
90% of all payroll accounts require that users complete an additional multi-factor authentication (MFA) step.

​
Expired credentials

Some payroll systems require users to reset their passwords periodically. When this occurs, an expired_credentials error will be shown in the account’s details.
  • When credentials expire, have the user return to Link.
  • On the account’s login screen, a Login help button will take the user to their payroll system’s platform. After the user resets their username or password, they need to return to Link and enter their updated credentials to re-establish the connection.
Users who need to change their login credentials can find a password reset link on their account connection page.

​
Simulating disconnections

When Console is in Sandbox mode, Flows provides an error testing feature that lets you simulate account disconnections. Visit our Sandbox Testing Guide for more information on error testing in Console and via the API.

​
Revoking access

Users can revoke access to their accounts at any time by emailing us at [email protected].
Within Link, users are shown which payroll accounts they have previously connected. After selecting a connected account, users are always presented with an option to revoke access to the account. After revoking access, data from the payroll account will no longer be retrievable through Console or the API.
If an account is revoked by the user, or deleted via Console or via the API, and the user later connects the same payroll account in Link, a new account ID will be created that is distinct from the original revoked/deleted account.
For more information on permissioned access and privacy, visit our data security guide.
Users can select Revoke Access when within Link and viewing a connected account.

​
Webhooks

We recommend subscribing to the accounts.updated webhook to be notified when an account becomes disconnected.
When subscribing, make sure to set include_resource to true using the config parameter to always receive a payload with the updated account’s details.
To determine whether an accounts.updated webhook was triggered by an account disconnection:
  1. Examine the connection.status field of the account object included in the webhook payload.
  2. If the value of connection.status is error, and the error_message is either auth_required or expired_credentials, an account disconnection has occurred.
Subscribe to the accounts.removed webhook to be notified when a user revokes access to one of their connected accounts.