TRtruv
Uploaded Documents

List all documents

Changed on

The endpoint returns a list of documents.

Note: When the other document type is enabled in the document upload settings of your customization template, end users can upload arbitrary documents that don't fit the other categories. Truv does not parse these OTHER documents into structured data (they are captured only), but you can collect the uploaded files through this Uploaded Documents API.

get/v1/links/{link_id}/documents/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/documents/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Response

idstring

Document ID

type'PAYSTUB' | 'W2' | 'F1099' | 'F1040' | 'VOLUNTEER_LETTER' | 'PCS_ORDERS' | 'INSURANCE_HOME_POLICY' | 'INSURANCE_AUTO_POLICY' | 'OTHER'

Document type.

OTHER documents are captured only: end users can upload arbitrary files that Truv does not parse into structured data. These documents are not parsed, but you can still collect them through the Uploaded Documents API. OTHER is only returned when the other document type is enabled in the document upload settings of your customization template.

subtype'F1099_B' | 'F1099_DIV' | 'F1099_G' | 'F1099_INT' | 'F1099_K' | 'F1099_MISC' | 'F1099_NEC' | 'F1099_R' | 'F_SSA1099' | 'VOL_HOURS_LOG' | 'VOL_TRANSCRIPT' | 'null' nullable

Document subtype

filestring uri

Document file link. The file could be absent or partially uploaded.

filenamestring required

Document file name

mimetypestring

Document mimetype

created_atstring date-time

Date when a document was uploaded

updated_atstring date-time

Date when a document was updated

Example response

[
  {
    "id": "24d7e80942ce4ad58a93f70ce4115f5c",
    "type": "W2",
    "subtype": "F1099_DIV",
    "file": "https://cdn.truv.com/doc_upload/most.recent.paystub.pdf",
    "filename": "most.recent.paystub.pdf",
    "mimetype": "application/pdf"
  }
]

Changes

  • e20fd88e9371Revision changes
    • warning

      added the new PCS_ORDERS enum value to the / response property for the response status

  • 452d978c111fRevision changes
    • warning

      added the new F1099_B enum value to the / response property for the response status

    • warning

      added the new F1099_K enum value to the / response property for the response status