Skip to main content
Use the Data APIs when your application needs payroll records, uploaded documents, or OCR results for its own workflow. Users connect their payroll accounts through Link. Your application tracks each account independently, waits for the required data, and retrieves the relevant resources from the API.
The Data APIs workflow on this page does not apply to banking. For bank connections and reports, use Banking Verifications. The account connection steps below apply to payroll data; for uploaded documents and OCR results, see Document uploads.

​
Implementation path

1

Create or reuse a user

Reuse the person’s existing user ID if they have already used another product with your organization. Otherwise, create a user and store the returned ID with your internal record.
2

Start the connection experience

Create a user token, then launch embedded or hosted Link.
3

Track connected accounts

Subscribe to the accounts.added, accounts.updated, and accounts.failed webhooks. Treat each connected account as an independent data source.
4

Wait for the data you need

Use resource webhooks and the users.fully_synced webhook to determine when the required data is available. See Data Delivery and Readiness.
5

Retrieve data sets

Retrieve identities, paystubs, payroll documents, gigs, shifts, vehicles, ratings, and other available resources through the corresponding endpoints.When using identities with paystubs or payroll documents, use the employment field to match records for the same employment. An account can contain records from more than one job.

​
Data structure

Argyle organizes connected payroll data around users, accounts, employments, data sets, and Items.

Data Delivery and Readiness

Understand when initial data is available and which webhooks indicate progress.

Ongoing Refresh

Monitor connected accounts for new data and required reconnections.

​
Document uploads

Users can upload documents through Link, or you can upload files through the API. A payroll connection is not required. Retrieve the files through User Uploads. When OCR is enabled, use OCR webhooks to track processing and retrieve the results from metadata.ocr_documents[] on the upload object. See Document Uploads for setup instructions and OCR and Authenticity for result fields and errors.

​
Verticals

Some verticals use direct Data APIs; others use the Verifications lifecycle. Explore Verticals to find implementation guidance for your industry or program.
If you need a standardized verification lifecycle and report instead of direct resource retrieval, start with Verifications.