TRtruv
Benefit Letters

List all benefit letters

Changed on

The endpoint returns the benefit letters of a link, such as the veteran's VA Benefit Verification letter. Each item names the letter and links to the file it was read from; retrieve a letter to get the values read from it.

A refresh fetches a new letter, so a link can hold more than one. The list is ordered by the pay date of the statement each letter was fetched with, newest first, so the first item is the most recent letter. Re-reading an older letter does not move it ahead.

document_type says which letter an item is and so which shape its fields take on retrieve. Only VA_BENEFIT_LETTER letters are returned today; SSA_BENEFIT_LETTER is reserved for the Social Security benefit letter.

Returns an empty array when the link has no benefit letter, including for a VA link whose letter has not been parsed yet.

get/v1/links/{link_id}/benefit_letters/

Request

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

Response

idstring

Benefit letter ID

document_type'VA_BENEFIT_LETTER' | 'SSA_BENEFIT_LETTER'

Benefit letter type. It decides the shape of fields on retrieve. VA_BENEFIT_LETTER is the VA Benefit Verification letter, whose fields are described by VaBenefitLetterFields. SSA_BENEFIT_LETTER is reserved for the Social Security benefit letter; none are returned yet, and its fields will be documented when they are.

filestring uri nullable

Link to the file the letter was read from

md5sumstring nullable

MD5 checksum of the file

created_atstring date-time

Time the letter was first read

updated_atstring date-time

Time the values read from the letter last changed

Example response

[
  {
    "id": "24d7e80942ce4ad58a93f70ce4115f5c",
    "document_type": "VA_BENEFIT_LETTER",
    "file": "https://cdn.truv.com/paystub_sample.pdf",
    "md5sum": "24d7e80942ce4ad58a93f70ce4115f5c",
    "created_at": "2026-09-02T10:15:30.123456Z",
    "updated_at": "2026-09-02T10:15:30.123456Z"
  }
]

Changes