Definition
An account represents a user’s connection to an income source. It can contain records from more than one employment. Users create accounts by finding an employer or payroll provider in Link and submitting the login credentials they use for that source.
The Accounts API applies to payroll connections and related Link activity. Financial accounts used for banking verifications are separate Bank Account resources.
Standard payroll connection
- The user searches for the employer or payroll provider that sends their income.
- The user enters their credentials in the source-specific login screen.
- An account record is created for the connection attempt.
- When authentication succeeds, payroll data begins arriving in stages.
Account records
Account objects are created when a user:- Successfully connects an employer, payroll provider, gig platform, government source, or other supported Item.
- Attempts a connection that does not complete successfully.
- Uploads a document through Link.
- Submits a response form after they cannot find their income source.
Connected accounts
A payroll account is connected after the user submits their credentials through Link and authentication succeeds. Data from that account is then delivered in stages. Follow Data Delivery and Readiness before deciding which account or resource event makes your workflow ready.Attempted connections
An account can also represent an unsuccessful connection attempt. Use the account status and error information to determine whether the user can retry, needs to reconnect, or must choose another income source.Track accounts
Subscribe to account webhooks:
Do not treat one account’s status as the status for every account attached to the user.