Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.argyle.com/llms.txt

Use this file to discover all available pages before exploring further.

​
The user upload object

For upload endpoint details, see Upload A Document.
​
id
string<uuid>

Unique ID of the uploaded document.

​
account
string<uuid>

ID of the account associated with the uploaded document.

​
document_type
string

The document category in Link the user selected, or the document_type provided when uploading via the API.

If OCR processing is enabled, this value is overwritten when the document is found to be a different type.

Possible values:

  • paystubs
  • W-2
  • 1099
  • proof-of-identity
  • proof-of-address
  • miscellaneous
​
file_url
string

URL linking to the original uploaded document file.

This static URL redirects to a download page that requires Argyle authentication headers.

Implementation requirements for client-side applications

  1. Ensure your HTTP client or library (for example, Axios or Python requests) is configured to follow redirects.
  2. Append Basic authentication headers for Argyle to the file download request.
​
file_name
string

File name of the uploaded document on the user's computer or phone.

​
metadata
object

Contains document OCR and authenticity information.

​
processing
object

Contains OCR processing statuses.

​
created_at
string<date-time>

Timestamp (ISO 8601) when the uploaded document was submitted.

​
updated_at
string<date-time>

Timestamp (ISO 8601) when the user upload object was last updated.