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

Attributes
  • #
    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 | paystubs | proof_of_identity | proof_of_address | miscellaneousArrays 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.

  • #
    ocr_authenticityobject

    Contains 3rd party OCR authenticity information.


    Details on individual instances of tampering or other authenticity-related edits made to the uploaded document that were detected.

  • #
    ocr_authenticity_scoreinteger

    Contains 3rd party OCR authenticity information.


    Single score that captures the likelihood the uploaded document is authentic, as determined by Ocrolus.

  • #
    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.

Example
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        "ocr_authenticity": {},
14        "ocr_authenticity_score": null,
15        "created_at": "2023-03-17T10:40:01.499477Z"
16      },
17      {
18        "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
19        "file_url": "www.argyle.com/storagename",
20        "file_name": "2022 W2.pdf",
21        "metadata": {},
22        "ocr_data": {},
23        "ocr_authenticity": {},
24        "ocr_authenticity_score": null,
25        "created_at": "2023-03-17T10:41:46.348228Z"
26      }
27    ],
28    "paystubs": [
29      {
30        "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
31        "file_url": "www.argyle.com/storagename",
32        "file_name": "most_recent_paystub.pdf",
33        "metadata": {},
34        "ocr_data": {},
35        "ocr_authenticity": {},
36        "ocr_authenticity_score": null,
37        "created_at": "2023-03-17T10:45:13.542269Z"
38      }
39    ]
40  },
41  "created_at": "2023-03-17T10:40:00.672839Z",
42  "updated_at": "2023-03-17T10:45:20.035736Z"
43}

#Retrieve a user form

get/v2/user-forms/{id}

Retrieves a user form object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the user form object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/user-forms/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
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        "ocr_authenticity": {},
14        "ocr_authenticity_score": null,
15        "created_at": "2023-03-17T10:40:01.499477Z"
16      },
17      {
18        "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
19        "file_url": "www.argyle.com/storagename",
20        "file_name": "2022 W2.pdf",
21        "metadata": {},
22        "ocr_data": {},
23        "ocr_authenticity": {},
24        "ocr_authenticity_score": null,
25        "created_at": "2023-03-17T10:41:46.348228Z"
26      }
27    ],
28    "paystubs": [
29      {
30        "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
31        "file_url": "www.argyle.com/storagename",
32        "file_name": "most_recent_paystub.pdf",
33        "metadata": {},
34        "ocr_data": {},
35        "ocr_authenticity": {},
36        "ocr_authenticity_score": null,
37        "created_at": "2023-03-17T10:45:13.542269Z"
38      }
39    ]
40  },
41  "created_at": "2023-03-17T10:40:00.672839Z",
42  "updated_at": "2023-03-17T10:45:20.035736Z"
43}

#List all user forms

get/v2/user-forms

Returns an array of all user form objects.

Query parameters
  • #
    accountstring (uuid)
    optional

    Filter by account ID.

  • #
    userstring (uuid)
    optional

    Filter by user ID.

  • #
    limitinteger
    optional

    Number of user form objects returned per page. Default: 10. Maximum: 200.

Example Request
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'
Example Response
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          "ocr_authenticity": {},
26          "ocr_authenticity_score": null,
27          "created_at": "2023-03-17T10:40:01.499477Z"
28        },
29        {
30          "user_document": "0186bf23-1e6a-c11c-54ba-224ef41a00b3",
31          "file_url": "www.argyle.com/storagename",
32          "file_name": "2022 W2.pdf",
33          "metadata": {},
34          "ocr_data": {},
35          "ocr_authenticity": {},
36          "ocr_authenticity_score": null,
37          "created_at": "2023-03-17T10:41:46.348228Z"
38        }
39      ],
40      "paystubs": [
41        {
42          "user_document": "0186bf7c-72a5-0648-a1d8-050ab452bc2d",
43          "file_url": "www.argyle.com/storagename",
44          "file_name": "most_recent_paystub.pdf",
45          "metadata": {},
46          "ocr_data": {},
47          "ocr_authenticity": {},
48          "ocr_authenticity_score": null,
49          "created_at": "2023-03-17T10:45:13.542269Z"
50        }
51      ]
52    },
53    "created_at": "2023-03-17T10:40:00.672839Z",
54    "updated_at": "2023-03-17T10:45:20.035736Z"
55  }
56]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com