Veterans Affairs (VA) Award Letter

Suggest Edits

This letter is issued by the Department of Veterans Affairs (VA) when a decision has been made regarding a veteran's claim for benefits issued A VA award letter. Specifically, this letter indicates a veteran's disability rating(s) along with the corresponding amount of monthly compensation.

The form_type parameter VA_AWARD_LETTER for the Upload PDF endpoint is required for this Form Type.

Field descriptions

The following fields are available on this form type:

JSON Attribute	Data Type	Description
`va_award_letter-Part1-General:documentDate`	Date	Document Date
`va_award_letter-Part1-General:claimNumber`	Text	Claim Number
`va_award_letter-Part1-General:beneficiaryName`	Text	Beneficiary Name
`va_award_letter-Part1-General:beneficiaryAddress:addressLine1`	Text	Beneficiary Address
`va_award_letter-Part1-General:beneficiaryAddress:addressLine2`	Text	Beneficiary Address
`va_award_letter-Part1-General:beneficiaryAddress:city`	City	Beneficiary Address
`va_award_letter-Part1-General:beneficiaryAddress:state`	State	Beneficiary Address
`va_award_letter-Part1-General:beneficiaryAddress:zipCode`	ZIP Code	Beneficiary Address
`va_award_letter-Part1-General:grossBenefitAmount`	Money	Gross Benefit Amount
`va_award_letter-Part1-General:netAmountPaid`	Money	Net Amount Paid
`va_award_letter-Part1-General:effectiveDate`	Date	Effective Date
`va_award_letter-Part1-General:evaluation%`	Percentage	Evaluation %

Sample form

drive.google.com

VA Award Letter - API Sample.pdf

Sample JSON result

{
   "status":200,
   "response":{
      "pk":30317540,
      "uuid":"0e8f78ac-8d1f-4dab-bdd5-bebd0ad4b4c5",
      "name":"VA Award letter",
      "created":"2023-03-06T17:27:32Z",
      "created_ts":"2023-03-06T17:27:32Z",
      "verified_pages_count":2,
      "book_status":"ACTIVE",
      "id":30317540,
      "forms":[
         {
            "pk":44715179,
            "uuid":"72f0c3ab-273e-4b64-92ab-430b9539c2b6",
            "uploaded_doc_pk":52507869,
            "form_type":"VA_AWARD_LETTER",
            "raw_fields":{
               "va_award_letter-Part1-General:claimNumber":{
                  "value":"XXX-XX-1234",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:evaluation%":{
                  "value":"100%",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:documentDate":{
                  "value":"01/06/2018",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:effectiveDate":{
                  "value":"12/18/2021",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:netAmountPaid":{
                  "value":"908.00",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryName":{
                  "value":"JOHN SAMPLE",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:grossBenefitAmount":{
                  "value":"",
                  "is_empty":true,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryAddress:city":{
                  "value":"SAMPLE CITY",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryAddress:state":{
                  "value":"NY",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryAddress:zipCode":{
                  "value":"12345",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryAddress:addressLine1":{
                  "value":"1234 FAKE STREET ROAD",
                  "is_empty":false,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               },
               "va_award_letter-Part1-General:beneficiaryAddress:addressLine2":{
                  "value":"",
                  "is_empty":true,
                  "alias_used":null,
                  "source_filename":"VA Award Letter - API Sample.pdf"
               }
            },
            "form_config_pk":141325,
            "tables":[
               
            ]
         }
      ],
      "book_is_complete":true
   },
   "message":"OK"
}

Updated about 2 months ago