Benefit Letters

Retrieve benefit letter

Changed on

The endpoint returns a benefit letter with the values read from it in fields. document_type says which shape fields has; for VA_BENEFIT_LETTER, the only type returned today, it carries the combined evaluation, the effective date of the award, and the gross and net monthly benefit amounts.

Every field is read from the letter and is never derived. The VA combines rated conditions with its own table and rounds to the nearest ten (38 CFR 4.25), so individual ratings do not add up to combined_evaluation, and the letter prints only the combined figure.

A field is null when the letter did not state that line. 0 and "0.00" are real values and are returned as such, so an absent line is always distinguishable from a zero one.

The rating and the amounts are independent: a benefit can be waived, offset against military retired pay, apportioned or withheld, so a veteran at 100 percent can be paid 0.00. The letter prints no deduction lines, so a difference between gross_benefit_amount and net_amount_paid is reported but never explained.

Both amounts are monthly and in US dollars. The letter states neither — VA disability compensation is paid monthly in US dollars for every letter — so the response carries no currency and no cadence field.

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

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/benefit_letters/{benefit_letter_id}/
  • 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",
  "fields": {
    "combined_evaluation": 70,
    "effective_date": "2025-12-01",
    "gross_benefit_amount": "1986.45",
    "net_amount_paid": "1986.45"
  }
}

Changes