Va

Veteran Confirmation

The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.…

Government & public#openapi#open-data

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

The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.

The API will only return “Confirmed” or “Not Confirmed”.

Quickstart Guide

1. Get Access Credentials

Get started by filling out the form on the Apply for VA Lighthouse Developer Access page.

After submitting a request, you will receive your credentials for using the API in the Development environment, which allows you to try it out with mock data before moving to the Production environment.

2. Test the API

In the endpoint documentation below, we've provided a curl command builder for trying out the API before implementation with your app.
Use Test User attributes to populate the request body.

3. Build your app

The base URI for the Veteran Confirmation API in the Sandbox environment is:

https://sandbox-api.va.gov/services/veteran_confirmation/v0

In this environment, use attributes from the list of Test Users. Only Test Users can return a "confirmed" response.

Check out some of our sample apps. Please visit our VA Lighthouse Support portal should you need further assistance.

4. Show us a demo and get access to the Production environment

After building your app, we ask that you give us a demo before we set you up with production credentials. Please see the Path to Production page for more details.

Authorization

This API requires an API key in combination with identifiable information for the person being confirmed listed below. API requests are authorized through a symmetric API token provided in an HTTP header with name apikey. Including more information has a better chance of making a match and returning a Confirmed status.

Required information:

  • First Name
  • Last Name
  • Date of Birth
  • Social Security Number

Optional information:

  • Middle Name
  • Gender

Reference

Sandbox vs. Production Data

APIs accessed via the Sandbox environment are using the same underlying logic as VA’s production APIs; only the underlying data store is different.

Master Veteran Index (MVI)

The Master Veteran Index confirms a user's identity. In Production, several factors are considered to confirm identity. These include: a user’s first name, last name, date of birth and Social Security number. The MVI is mocked in the Sandbox environment. In this environment, the only factor used to confirm identity is the Social Security number.

Rate Limiting

We implemented basic rate limiting of 60 requests per minute. If you exceed this quota, your request will return a 429 status code. You may petition for increased rate limits by emailing and requests will be decided on a case by case basis.

Raw Open API Spec

https://api.va.gov/services/veteran_confirmation/docs/v0/api

Endpoints 1

veteran_confirmation_status

  • POSTGet confirmation about an individual's Veteran status according to the VA/status

API details

Base URL
https://sandbox-api.va.gov/services/veteran_confirmation/{version}
https://api.va.gov/services/veteran_confirmation/{version}
Authentication
An API key in the apikey header
Operations
1 operation on 1 pathPOST 1
Main resources
veteran_confirmation_status 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Veteran Confirmation 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 Veteran Confirmation 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 “Get confirmation about an individual's Veteran status according to the VA” (POST /status), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Veteran Confirmation?

The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.… It is listed under Government & public and has 1 endpoint.

Who publishes the Veteran Confirmation?

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 Veteran Confirmation?

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

How do I authenticate with the Veteran Confirmation?

With an API key in the apikey header.

How many endpoints does the Veteran Confirmation have?

1 operation on 1 path (1 POST). The largest groups are veteran_confirmation_status.

Is forking the Veteran Confirmation 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.