TRtruv
Tax Documents

Retrieve tax document

Changed on

The endpoint returns a tax document.

get/v1/links/{link_id}/tax/{tax_id}/

Request

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

Response

idstring

Tax document ID

document_type'W2' | 'F1099' | 'F1040' required

Tax document type

document_subtype'F1099_B' | 'F1099_DIV' | 'F1099_G' | 'F1099_INT' | 'F1099_K' | 'F1099_MISC' | 'F1099_NEC' | 'F1099_R' | 'F_SSA1099' | 'null' nullable

Tax document subtype

filestring uri nullable

Tax document file link

md5sumstring nullable

Tax document md5sum

yearinteger nullable

Tax document year

fieldsobject nullable

Tax document fields. Set of fields depends on the document type and subtype.

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "document_type": "W2",
  "document_subtype": "F1099_DIV",
  "file": "https://cdn.truv.com/files_examples/w2.pdf",
  "md5sum": "24d7e80942ce4ad58a93f70ce4115f5c",
  "year": 2022
}

Changes

  • 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

  • e58688835e25Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status