Skip to main content
“Data sets” are categories of payroll information made available when a user connects an employer or payroll-provider account. Your application can retrieve the structured records through the API and download source files when the connected account provides them.
This data-set model applies to payroll accounts. Banking implementations should use Banking Verifications and completed banking reports. Bank Accounts and Financial Institutions are supporting banking resources, not payroll data sets.
Payroll data is organized into data sets such as paystubs and payroll documents.

Categories

Follow each category link for its complete fields and endpoint examples.

Matching employments

Use the employment field to match identities, paystubs, and payroll documents for the same employment. Employer names can differ between these records, and one account can contain records from more than one job. See Employments for matching records, filtering requests, and handling unmatched paystubs.

Field availability

Field support varies by Item and by the information present in the user’s account.
  • In Console, select an Item in Coverage and review its field availability.
  • In the API, retrieve the Item and inspect field_coverage.
A supported field can still be empty when the connected account contains no value for that user. For example, an Item may support profile images even when a specific user has not added one.

Delivery timing

Resource objects arrive and update in stages. Use the corresponding resource webhooks and follow Data Delivery and Readiness before treating a data set as complete for your workflow.