User Uploads
Retrieve manually uploaded documents.
- Retrieve documents manually uploaded through Link.
- Retrieve OCR data and authenticity information for uploaded documents.
#The user upload object
- #idstring (uuid)
Unique ID of the uploaded document.
- #accountstring (uuid)
ID of the account associated with the uploaded document.
- #document_typestring (enum)
The document category in Link the user selected.
- #file_urlstring
URL linking to the original uploaded document file.
This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.
- #file_namestring
File name of the uploaded document on the user's computer or phone.
- #metadataobject
Contains document OCR and authenticity information.
- #ocr_dataobject
Contains Ocrolus OCR data.
Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
- #ocr_authenticityobject
Contains Ocrolus authenticity data.
Includes individual instances of tampering or other authenticity-related edits made to the uploaded document that were detected.
Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
- #ocr_authenticity_scoreinteger
Single score that captures the likelihood the uploaded document is authentic, as determined by Ocrolus.
Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
- #created_atstring (datetime)
Timestamp (ISO 8601) when the uploaded document was submitted.
- #updated_atstring (datetime)
Timestamp (ISO 8601) when the user upload object was last updated.
1{
2 "id": "01320596-2c3d-189c-53e7-a8ce6d625b33",
3 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
4 "document_type": "proof-of-identity",
5 "file_url": "www.argyle.com/storagename",
6 "file_name": "my_drivers_license.pdf",
7 "metadata": {
8 "ocr_data": {},
9 "ocr_authenticity": {},
10 "ocr_authenticity_score": null
11 },
12 "created_at": "2024-07-08T13:43:49.864033Z",
13 "updated_at": "2024-07-08T13:43:51.868787Z"
14}#Retrieve a user upload
Retrieves a user upload object.
- #idstring (uuid)required
ID of the user upload object to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v2/user-uploads/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1{
2 "id": "01320596-2c3d-189c-53e7-a8ce6d625b33",
3 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
4 "document_type": "proof-of-identity",
5 "file_url": "www.argyle.com/storagename",
6 "file_name": "my_drivers_license.pdf",
7 "metadata": {
8 "ocr_data": {},
9 "ocr_authenticity": {},
10 "ocr_authenticity_score": null
11 },
12 "created_at": "2024-07-08T13:43:49.864033Z",
13 "updated_at": "2024-07-08T13:43:51.868787Z"
14}#List all user uploads
Returns an array of all user upload objects.
1curl --request GET \
2 --url https://api.argyle.com/v2/user-uploads?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1[
2 {
3 "id": "01320596-2c3d-189c-53e7-a8ce6d625b33",
4 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
5 "document_type": "proof-of-identity",
6 "file_url": "www.argyle.com/storagename",
7 "file_name": "my_drivers_license.pdf",
8 "metadata": {
9 "ocr_data": {},
10 "ocr_authenticity": {},
11 "ocr_authenticity_score": null
12 },
13 "created_at": "2024-07-08T13:43:49.864033Z",
14 "updated_at": "2024-07-08T13:43:51.868787Z"
15 },
16 {
17 "id": "01305921-2ce3-723b-3309-14a27983e765",
18 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
19 "document_type": "W-2",
20 "file_url": "www.argyle.com/storagename",
21 "file_name": "2024_W2.pdf",
22 "metadata": {
23 "ocr_data": {},
24 "ocr_authenticity": {},
25 "ocr_authenticity_score": null
26 },
27 "created_at": "2024-07-08T13:44:27.734038Z",
28 "updated_at": "2024-07-08T13:44:29.738182Z"
29 }
30]