Uploaded Documents

Find more information about the responses for uploaded documents.


The table below covers information from the response for uploaded documents. The response body is an array of objects and can include multiple document values.

idstringDocument ID
typestringDocument type, valid responses below
PAYSTUB, W2, F1099, F1040
subtypestring, nullDocument subtype, valid responses below
F1099_DIV, F1099_G, F1099_INT, F1099_MISC, F1099_NEC, F1099_R, F_SSA1099
fileuriDocument file link, file may be absent or partially uploaded
filenamestringDocument file name
mimetypestringDocument mimetype
created_atdate-timeDate when document was uploaded
updated_atdate-timeDate when document was updated


Use the endpoints below to get information on uploaded documents.

Example response

The sample below is a JSON response for the endpoint.

    "id": "24d7e80942ce4ad58a93f70ce4115f5c",
    "type": "W2",
    "subtype": null,
    "file": "https://citadelid-resources.s3.us-west-2.amazonaws.com/doc_upload/most.recent.paystub.pdf",
    "filename": "most.recent.paystub.pdf",
    "mimetype": "application/pdf",
    "created_at": "2023-08-03T23:52:12.751Z",
    "updated_at": "2023-08-03T23:52:12.751Z"