Va

VA Forms

Use the VA Forms API to search for VA forms, get the form's PDF link and metadata, and check for new versions. Visit our VA Lighthouse [Contact Us…

Government & public#openapi#forms

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use the VA Forms API to search for VA forms, get the form's PDF link and metadata, and check for new versions.

Visit our VA Lighthouse Contact Us page for further assistance.

Background

This API offers an efficient way to stay up-to-date with the latest VA forms and information. The forms information listed on VA.gov matches the information returned by this API.

  • Search by form number, keyword, or title
  • Get a link to the form in PDF format
  • Get detailed form metadata including the number of pages, related forms, benefit categories, language, and more
  • Retrieve the latest date of PDF changes and the SHA256 checksum
  • Identify when a form is deleted by the VA

Technical summary

The VA Forms API collects form data from the official VA Form Repository on a nightly basis. The Index endpoint can return all available forms or, if an optional query parameter is passed, will return only forms that may relate to the query value. When a valid form name is passed to the Show endpoint, it will return a single form with additional metadata and full revision history. A JSON response is given with the PDF link (if published) and the corresponding form metadata.

Authentication and authorization

The form information shared by this API is publicly available. API requests are authorized through a symmetric API token, provided in an HTTP header with name apikey. Get a sandbox API Key.

Testing in sandbox environment

Form data in the sandbox environment is for testing your API only, and is not guaranteed to be up-to-date. This API also has a reduced API rate limit. When you're ready to move to production, be sure to request a production API key.

SHA256 revision history

Each form is checked nightly for recent file changes. A corresponding SHA256 checksum is calculated, which provides a record of when the PDF changed and the SHA256 hash that was calculated. This allows end users to know that they have the most recent version and can verify the integrity of a previously downloaded PDF.

Valid PDF link

Additionally, during the nightly refresh process, the link to the form PDF is verified and the valid_pdf metadata is updated accordingly. If marked true, the link is valid and is a current form. If marked false, the link is either broken or the form has been removed.

Deleted forms

If the deleted_at metadata is set, that means the VA has removed this form from the repository and it is no longer to be used.

Endpoints 2

Forms

  • GETReturns all VA Forms and their last revision date/forms?query=stringReturns an index of all available VA forms. Optionally, pass a query parameter to filter forms by form number or title.
  • GETFind form by form name/forms/:form_nameReturns a single form and the full revision history

API details

Base URL
https://sandbox-api.va.gov/services/va_forms/{version}
https://api.va.gov/services/va_forms/{version}
Authentication
An API key in the apikey header
Operations
2 operations on 2 pathsGET 2
Main resources
Forms 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the VA Forms in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the VA Forms collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the apikey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Returns all VA Forms and their last revision date” (GET /forms?query=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the VA Forms?

Use the VA Forms API to search for VA forms, get the form's PDF link and metadata, and check for new versions. Visit our VA Lighthouse [Contact Us… It is listed under Government & public and has 2 endpoints.

Who publishes the VA Forms?

It is listed from Va's public API description (an OpenAPI document), not published by Va on Swastik Codes. Anyone who controls va.gov can claim the profile by adding a DNS TXT record.

What is the base URL of the VA Forms?

Its description lists 2 base URLs: https://sandbox-api.va.gov/services/va_forms/{version}, https://api.va.gov/services/va_forms/{version}. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the VA Forms?

With an API key in the apikey header.

How many endpoints does the VA Forms have?

2 operations on 2 paths (2 GET). The largest groups are Forms.

Is forking the VA Forms free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.