Share via


Veterans Affairs Forms (Independent Publisher) (Preview)

Access the VA Forms API to search, retrieve PDF links, and metadata for VA forms, including version tracking. Stay updated with the latest VA form information, search by form number or keyword, get detailed metadata, and more. Authenticate using an API token. Test in the sandbox environment before requesting a production API key. Track SHA256 revision history to ensure data integrity and validate PDF links. Identify deleted forms through metadata.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Richard Wilson
URL https://www.richardawilson.com/
Email richard.a.wilson@microsoft.com
Connector Metadata
Publisher Richard Wilson
Website https://developer.va.gov/explore/api/va-facilities
Privacy policy https://department.va.gov/privacy/
Categories Human Resources

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
VA API Key securestring The VA API Key for this api True
Environment string The VA API environment to use (Production or Sandbox) True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get form by name

Retrieve a single form and its full revision history

List forms

Retrieve all available VA forms. Optionally filter by form number or title.

Get form by name

Retrieve a single form and its full revision history

Parameters

Name Key Required Type Description
Form Name
form_name True string

The VA form name of the form being requested. Include prefixes and hyphens where necessary.

Returns

Data for a particular VA form, including form version history.

Body
FormShow

List forms

Retrieve all available VA forms. Optionally filter by form number or title.

Parameters

Name Key Required Type Description
Query
query string

Retrieve form data based on entered form name.

Returns

Name Path Type Description
data
data array of FormsIndex

Definitions

FormsIndex

A listing of available VA forms and their location.

Name Path Type Description
Id
id string

JSON API identifier

Type
type string

JSON API type specification

Form Name
attributes.form_name string

Name of the VA Form

Url
attributes.url string

Web location of the form

Title
attributes.title string

Title of the form as given by VA

First Issued On
attributes.first_issued_on date

The date the form first became available

Last Revision On
attributes.last_revision_on date

The date the form was last updated

Pages
attributes.pages integer

Number of pages contained in the form

Sha256
attributes.sha256 string

A sha256 hash of the form contents

Last Sha256 Change
attributes.last_sha256_change date

The date of the last sha256 hash change

Valid Pdf
attributes.valid_pdf boolean

A flag indicating whether the form URL was confirmed as a valid download

Form Usage
attributes.form_usage string

A description of how the form is to be used

Form Tool Intro
attributes.form_tool_intro string

Introductory text describing the VA online tool for this form

Form Tool Url
attributes.form_tool_url string

Location of the online tool for this form

Form Details Url
attributes.form_details_url string

Location on www.va.gov of the info page for this form

Form Type
attributes.form_type string

VA Type of the form

Language
attributes.language string

Language code of the form

Deleted At
attributes.deleted_at date-time

The timestamp at which the form was deleted

Related Forms
attributes.related_forms array of string

A listing of other forms that relate to the current form

Benefit Categories
attributes.benefit_categories array of object

Listing of benefit categories and match

Name
attributes.benefit_categories.name string

Name of the benefit category of the form

Description
attributes.benefit_categories.description string

Description of the benefit category of the form

VA Form Administration
attributes.va_form_administration string

The VA organization that administers the form

FormShow

Data for a particular VA form, including form version history.

Name Path Type Description
Id
id string

JSON API identifier

Type
type string

JSON API type specification

Form Name
attributes.form_name string

Name of the VA Form

Url
attributes.url string

Web location of the form

Title
attributes.title string

Title of the form as given by VA

First Issued On
attributes.first_issued_on date

The date the form first became available

Last Revision On
attributes.last_revision_on date

The date the form was last updated

Created At
attributes.created_at date-time

Internal field for VA.gov use

Pages
attributes.pages integer

Number of pages contained in the form

Sha256
attributes.sha256 string

A sha256 hash of the form contents

Valid Pdf
attributes.valid_pdf boolean

A flag indicating whether the form URL was confirmed as a valid download

Form Usage
attributes.form_usage string

A description of how the form is to be used

Form Tool Intro
attributes.form_tool_intro string

Introductory text describing the VA online tool for this form

Form Tool Url
attributes.form_tool_url string

Location of the online tool for this form

Form Details Url
attributes.form_details_url string

Location on www.va.gov of the info page for this form

Form Type
attributes.form_type string

VA Type of the form

Language
attributes.language string

Language code of the form

Deleted At
attributes.deleted_at date-time

The timestamp at which the form was deleted

Related Forms
attributes.related_forms array of string

A listing of other forms that relate to current form

Benefit Categories
attributes.benefit_categories array of object

Listing of benefit categories and match

Name
attributes.benefit_categories.name string

Name of the benefit category of the form

Description
attributes.benefit_categories.description string

Description of the benefit category of the form

VA Form Administration
attributes.va_form_administration string

The VA organization that administers the form

versions
attributes.versions array of object

The version history of revisions to the form

Sha256
attributes.versions.sha256 string

A sha256 hash of the form contents for that version

Revision On
attributes.versions.revision_on date

The date the sha256 hash was calculated