vets-api-clients (VA Lighthouse APIs)

Welcome to the repository for consumers of VA Lighthouse APIs. It includes API specifications, sample clients, and general access information. This README was last updated December 2020. For the most up-to-date Lighthouse API documentation, please visit developer.va.gov/explore. API documentation found in this repo may be outdated.

If you would like to improve or suggest edits to API documentation for the VA APIs, please visit the APIs repo or the Developer Portal repo.

If you are a third party seeking access to VA Lighthouse APIs, you will need to complete a quick application to obtain an API key. Once you have your API key, you can access our APIs in a sandbox environment. We grant production access later after scheduling a demo of your application for stakeholders and ensuring all requirements are met.

Publicly available APIs

Benefits Claims

• Use the Benefits Claims API (Auto-Establishment) to submit a Veteran's benefits claim via EVSS (Electronic Veterans Self-Service) or to request the status of a Veteran's benefits claim.

Benefits Intake (fka Document Upload Service)

• The Benefits Intake API allows authorized third-party systems used by Veterans Service Organizations and agencies to upload scanned, PDF claim documents directly to the Veterans Benefits Management System (VBMS) for the Veterans Benefits Administration's (VBA's) claims intake process.

Facilities

• Use the Facilities API to find the contact info, location, hours of operation, available services, and more for a specific VA facility.

Forms

• Use the Forms API to look up VA forms and check for new versions.

Health (FHIR)

• Use the Health APIs to allow Veterans to view their medical records, schedule an appointment, find a specialty facility, and share their information with caregivers and providers.

Community Care Eligibility

• Use the Community Care Eligibility API to check a Veteran's community care eligibility based on criteria and requirements defined in the MISSION Act and show the nearest facilities that meet the Veteran's needs based on the services for which they qualify.

Veteran Verification

• The Veteran Verification API accesses or verifies a Veteran's service history, Veteran status, discharge information, and disability rating.

Veteran Confirmation API

• Use the Veteran Confirmation API to confirm Veteran status. This can be useful for offering Veterans discounts or other benefits.

APIs for internal VA agencies only

These APIs are for use by VA departments only. You cannot request an API key or use this API unless you have VA authorization, including access to VA systems or a computer with a valid VA intranet IP address.

Address Validation

• The Address Validation API provides methods to both standardize and validate addresses.

Appeals Status

• Use the Appeals Status API to request the status of a Veteran's benefits claim appeal.

Decision Reviews

• Use the Decision Reviews API to interact with a Veteran's decision reviews, also known as benefit appeals.

Loan Guaranty

• Use the Loan Guaranty API to manage VA Home loans, including a home loan guarantee benefit and other housing-related programs which help Veterans buy, build, repair, retain, or adapt a home for their own personal occupancy.

Further Assistance

If you have any questions or need further assistance, please visit our support page, where you can contact us and peruse the FAQs. You will receive a human reply within one business day.

Incident and Outage Awareness (Statuspage)

Please visit and subscribe to alerts from the VA Lighthouse Statuspage for up-to-the minute reports on API and gateway functionality.