Document Processing

Documents can be uploaded directly through the API or collected from users in Link. Supported documents include W-2s, 1099s, paystubs, proof of identity, proof of address, and other files.

​

Uploading documents

​

User uploads within Link

Document uploads can be enabled and customized through the Flows section of Console.

How to enable document uploads on Link's intro screen

1. Create or edit an existing Flow.
2. In the Intro screen section, enable the “Intro screen” and “Document upload” toggles.
3. In the Document upload settings section:

• Customize the text of the document upload submission screen.
• Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category.

How to enable document uploads as a fallback (employer not found or incorrect login credentials)

1. Create or edit an existing Flow.
2. In the Search and connect section, scroll down to Fallback experiences and select the “Document upload” toggle for one or both fallback scenarios:

• User finds no search results (not applicable to Direct login flows): Users are prompted to upload documents when they are unable to locate their employer or payroll provider through Link search.
• User provides incorrect credentials: Users are prompted to upload documents when a payroll connection attempt is unsuccessful.

3. In the Document upload settings section:

• Customize the text of the document upload submission screen.
• Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category.

How to enable document uploads on Link's success screen (after an account connection)

1. Create or edit an existing Flow.
2. In the Success screen section, select “Allow users to upload documents after a successful connection”.
3. In the Document upload settings section:

• Customize the text of the document upload submission screen.
• Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category.

The following document uploaded categories are currently supported: If all document categories are marked as Optional, the option to “Skip document upload” will be presented to users: After enabling document uploads and saving your Flow in Console:

• Shareable URLs — Document uploads will be active when any user enters Link through your saved shareable URL.
• Email/SMS Templates — When inviting new users, select the Flow from the Template dropdown.
• Embedded Experiences — Copy the Flow ID from Console and add the following line to your Link initialization:
  flowId: "<Flow ID>" // (e.g. "V32M5YBC")
  

​

Document upload only

1. Create or edit an existing Flow.
2. In the Search and connect section, select “Doc upload”.
3. In the Document upload settings section:

• Customize the text of the document upload submission screen.
• Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category.

After saving the Flow, use its Flow ID when launching Link. Users will open the document upload screen without connecting a payroll account.

​

Additional uploads (returning users)

When document uploads are enabled, users can return to Link and upload additional documents or delete previously uploaded documents. Category limits configured in the Flow continue to apply when the user returns.

​

Direct uploads via the API

If you already collect documents outside Link, upload them with POST /v2/user-uploads.

​

Retrieving uploaded documents

Retrieve uploaded documents through the User Uploads API. Use User Upload webhooks for backend processing and onDocumentsSubmitted for immediate Link callback handling. Uploaded documents can also be retrieved within the Connections section of Console after selecting an individual user. Any uploaded documents will be available for download in an Uploaded documents tab.

​

Document authenticity and OCR

Supported uploaded documents can be processed through Ocrolus for OCR and authenticity signals. View the results in Console or retrieve metadata.ocr_documents[] through the User Uploads API. Use OCR webhooks to track OCR completion, failures, and authenticity results. See OCR errors when a document cannot be processed.

​

Supported file types

​

Restricting to only PDFs

Document uploads can be restricted to only PDF file types by enabling the Restrict to PDF only toggle for each document type in the Flows section of Console. When a document type is restricted to PDF only, Link will adjust accordingly to guide users. Depending on the device used to upload documents, they will either be prevented from selecting non-PDF file types or shown an error if a non-PDF file type is uploaded.