Legacy Docs

Document OCR Processors

Third party OCR for uploaded documents.


Third party OCR can be used for W-2, 1099, and paystub document uploads. The OCR data can be accessed alongside payroll-sourced data via Console or the API.

Enabling third party OCR#

Ocrolus OCR processing#

Upload your Ocrolus ID and Secret through the Integrations section of Console.

Ocrolus returns OCR data in a response field alongside an HTTP status code and Ocrolus status code. Argyle returns only OCR data from the response field, and not the status code. The response field will retain the format used by Ocrolus. Please refer to Ocrolus's documentation for further information on how this response field is formatted.

Argyle is not affiliated with, sponsored by, or endorsed by Ocrolus. A customer's right to use Ocrolus is subject to its separate agreement with Ocrolus (or otherwise with its authorized resellers or other contracting partners), if any.

Other OCR processors#

  1. Create dedicated API keys on the OCR processor's platform, to be solely used with Argyle.

  2. Reach out to your Argyle customer success manager, account executive, or [email protected].

Retrieving OCR data#

Console#

  1. Select an individual user within the Connections section of Console.
  2. Within Uploaded documents, an OCR tag is shown next to documents when OCR data is available.
  3. Click the JSON toggle to view OCR data.
    • Refer to your third party OCR processor's documentation for their data field descriptions.

API#

  1. Retrieve uploaded documents through the API's /user-forms endpoint.
  2. The ocr_data object will contain OCR data.
    • Refer to your third party OCR processor's documentation for their data field descriptions.

Webhooks for OCR data#

Subscribe to the following webhooks to be notified of OCR updates:

OCR errors#

Processing errors#

The following OCR processing errors are returned in the error field of the ocr_data object.

  • type_mismatch — The document type the user selected in Link while uploading does not match the uploaded document type. For example, the user selected W-2, but uploaded a 1099 document instead.
  • unrecognized_document_type — The user uploaded a document type that cannot be recognized as any of the currently supported document types (W-2, 1099, or paystub). For example, a 1095 form would be considered unrecognized.
  • unsupported_document_subtype — The user uploaded a specific, currently unsupported subtype of a document type that is otherwise supported. For example, while the most common 1099 documents are supported, a 1099-DIV document subtype is not currently supported.

Authentication errors#

If authentication to your third party OCR processor fails (for example, due to an invalid API key), and document processing cannot start, Argyle will reach out to you. Once the issue is resolved, the pending documents can be processed.