access_token that enables all subsequent data retrieval and modifications.
Tasks are the individual actions performed through Links (e.g., fetching income data, switching direct deposits). Each task progresses through a defined status lifecycle.
Task status flow
The following diagram illustrates the flow. Tasks progress sequentially through these statuses:mfa if the provider doesn’t require multi-factor authentication, or include switch_deposit for DDS tasks.
Status definitions
| Status | Description |
|---|---|
| new | Task initiated, queued for processing |
| login | Attempting to log into the payroll provider or bank |
| mfa | Completing multi-factor authentication |
| parse | Collecting identity, employment, and paystub data |
| full_parse | Initial parse complete; downloading and parsing paystubs, W-2s, and additional income sources |
| switch_deposit | Processing direct deposit allocation changes (DDS tasks only) |
| done | Task completed successfully |
Error states
Tasks may enter an error state at any point in the lifecycle:| Error Status | Description |
|---|---|
| login_error | Authentication failed: incorrect credentials |
| mfa_error | Multi-factor authentication was not completed |
| config_error | Configuration issue requiring user or developer action |
| account_locked | The payroll or bank account is locked |
| unable_to_reset | Failed to reset credentials at the provider |
| no_data | Provider connected successfully but returned no data |
| unavailable | Provider service is temporarily inaccessible |
| error | Generic connection failure |
| not_supported | Provider or HRIS system is not supported |
Data processing
See Data Processing for stage timing, median durations, data availability at each stage, and typical processing times.Relationship to Orders
Orders are the top-level containers for verification requests. When a user completes an Order:- The user authenticates through Bridge, creating a Link
- A Task is created on that Link to retrieve the requested data
- The Task progresses through the status lifecycle
- On completion, data is available via the API and the order status updates
Monitor tasks
Dashboard
View task details in the Dashboard under Activity > Tasks. Filter by status, date, and provider.API
Retrieve task status programmatically:Webhooks
Subscribe to task events for real-time monitoring:task-status-updatedwithstatus: done: task finished successfullytask-status-updatedwith an error status: task encountered an error