Sign in

v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB
Uploaded Documents

Retrieve document

The endpoint returns a document.

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

Response

idstring

Document ID

type'PAYSTUB' | 'W2' | 'F1099' | 'F1040' | 'VOLUNTEER_LETTER' | '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_DIV' | 'F1099_G' | 'F1099_INT' | '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"
}