User Forms
User form submissions.
User form submissions can come from two sources:
- Document uploads.
- Response forms when the user cannot find their employer or payroll provider.
#The user form object
Each user form object captures a single document upload or response form submission. For document uploads, multiple files can be uploaded during a single submission.
- #idstring (uuid)
Unique ID of the user form.
- #accountstring (uuid)
ID of the account associated with the user form.
A new account is created if the user only submits a user form and has not already attempted to connect a payroll account in Link.
- #statusstring (enum)
Status of the user form submission.
- #dataobject
Lists information for each user form submission by type.
- #income_sourcestring
Response forms only.
- #payroll_providerstring
Response forms only.
- #form_w2 | form_1099 | paystubsArrays of objects
Document uploads only.
- #user_documentstring (uuid)
Unique ID of the individual document.
- #file_urlstring
15 minute download link to the original document file. If the link expires, call this endpoint again to refresh the link.
- #file_namestring
File name of the uploaded document on the user's computer or phone.
- #metadataobject
Additional, non-categorized information.
- #ocr_dataobject
Contains 3rd party OCR data.
- #created_atstring (datetime)
Timestamp (ISO 8601) when the document was uploaded.
- #created_atstring (datetime)
Timestamp (ISO 8601) when the user form was submitted.
- #updated_atstring (datetime)
Timestamp (ISO 8601) when the user form object was last updated.
1{
2 "id": "0187bf23-cd80-118d-c0b8-58023e21c8e5",
3 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
4 "status": "submitted",
5 "data": {
6 "form_w2": [
7 {
8 "user_document": "0186eb22-b1c9-e10c-efa9-1e7832f22e68",
9 "file_url": "www.argyle.com/storagename",
10 "file_name": "2021 W2.pdf",
11 "metadata": {},
12 "ocr_data": {},
13 "created_at": "2023-03-17T10:40:01.499477Z"
14 },
15 {
16 "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
17 "file_url": "www.argyle.com/storagename",
18 "file_name": "2022 W2.pdf",
19 "metadata": {},
20 "ocr_data": {},
21 "created_at": "2023-03-17T10:41:46.348228Z"
22 }
23 ],
24 "paystubs": [
25 {
26 "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
27 "file_url": "www.argyle.com/storagename",
28 "file_name": "most_recent_paystub.pdf",
29 "metadata": {},
30 "ocr_data": {},
31 "created_at": "2023-03-17T10:45:13.542269Z"
32 }
33 ]
34 },
35 "created_at": "2023-03-17T10:40:00.672839Z",
36 "updated_at": "2023-03-17T10:45:20.035736Z"
37}#Retrieve a user form
Retrieves a user form object.
- #idstring (uuid)required
ID of the user form object to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v2/user-forms/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1{
2 "id": "0187bf23-cd80-118d-c0b8-58023e21c8e5",
3 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
4 "status": "submitted",
5 "data": {
6 "form_w2": [
7 {
8 "user_document": "0186eb22-b1c9-e10c-efa9-1e7832f22e68",
9 "file_url": "www.argyle.com/storagename",
10 "file_name": "2021 W2.pdf",
11 "metadata": {},
12 "ocr_data": {},
13 "created_at": "2023-03-17T10:40:01.499477Z"
14 },
15 {
16 "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
17 "file_url": "www.argyle.com/storagename",
18 "file_name": "2022 W2.pdf",
19 "metadata": {},
20 "ocr_data": {},
21 "created_at": "2023-03-17T10:41:46.348228Z"
22 }
23 ],
24 "paystubs": [
25 {
26 "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
27 "file_url": "www.argyle.com/storagename",
28 "file_name": "most_recent_paystub.pdf",
29 "metadata": {},
30 "ocr_data": {},
31 "created_at": "2023-03-17T10:45:13.542269Z"
32 }
33 ]
34 },
35 "created_at": "2023-03-17T10:40:00.672839Z",
36 "updated_at": "2023-03-17T10:45:20.035736Z"
37}#List all user forms
Returns an array of all user form objects.
1curl --request GET \
2 --url https://api.argyle.com/v2/user-forms?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1[
2 {
3 "id": "0186ef31-4a6c-bc77-ffb7-a9db11505d7d",
4 "account": "0182c1e2-59ec-16ba-34e2-4f20594a7df7",
5 "status": "submitted",
6 "data": {
7 "income_source": "My source of income is Block & Fish Tackle.",
8 "payroll_provider": "My payroll provider is Payroll Corp."
9 },
10 "created_at": "2023-03-17T10:50:30.414265Z",
11 "updated_at": "2023-03-17T10:50:31.621908Z"
12 },
13 {
14 "id": "0187bf23-cd80-118d-c0b8-58023e21c8e5",
15 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
16 "status": "submitted",
17 "data": {
18 "form_w2": [
19 {
20 "user_document": "0186eb22-b1c9-e10c-efa9-1e7832f22e68",
21 "file_url": "www.argyle.com/storagename",
22 "file_name": "2021 W2.pdf",
23 "metadata": {},
24 "ocr_data": {},
25 "created_at": "2023-03-17T10:40:01.499477Z"
26 },
27 {
28 "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
29 "file_url": "www.argyle.com/storagename",
30 "file_name": "2022 W2.pdf",
31 "metadata": {},
32 "ocr_data": {},
33 "created_at": "2023-03-17T10:41:46.348228Z"
34 }
35 ],
36 "paystubs": [
37 {
38 "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
39 "file_url": "www.argyle.com/storagename",
40 "file_name": "most_recent_paystub.pdf",
41 "metadata": {},
42 "ocr_data": {},
43 "created_at": "2023-03-17T10:45:13.542269Z"
44 }
45 ]
46 },
47 "created_at": "2023-03-17T10:40:00.672839Z",
48 "updated_at": "2023-03-17T10:45:20.035736Z"
49 }
50]