How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VA Lighthouse Documents Service API

The Documents Service API from VA Lighthouse — 9 operation(s) for documents service.

VA Lighthouse Documents Service API is one of 35 APIs that VA Lighthouse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, and authentication docs.

This API exposes 9 operations across 9 paths, and defines 41 schemas. It is described by OpenAPI 3.0.1, at version 3.

Requests are made against 2 base URLs: https://sandbox-api.va.gov/services/address-validation/{version}, https://api.va.gov/services/address-validation/{version}.

9 operations 9 paths 41 schemas 1 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3
Base URL
https://api.va.gov/services/va_facilities/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VA Lighthouse Documents Service API declares 1 security scheme for authenticating requests. An API key is passed in the header as apikey (apikey). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 1 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Documents Service 9
POST
/uploads/status
Returns the upload status of multiple disability claim documents.
POST:/uploads/status 1 param body → 200400404413429500502504
POST
/participant/documents/search
Returns all VBMS document names associated with a participantId.
POST:/participant/documents/search body → 200400404413429500502504
POST
/participant/documents/download
Download the document for a participant.
POST:/participant/documents/download body → 200400404413429500502504
POST
/documents
Uploads a file to a Veteran's VBMS eFolder.
POST:/documents body → 200400404413429500502504
POST
/documents/validate/claimant
Validates that the claimant can upload a file to a Veteran's VBMS eFolder.
POST:/documents/validate/claimant body → 200400404413429500502504
POST
/documents/search
Returns all claims evidence document names associated with a participantId or fileNumber.
POST:/documents/search body → 200400404413429500502504
POST
/claim-letters/search
Returns a list of downloadable Claims Evidence claim letter documents, along with their associated metadata, linked to a Participant ID or File Number.
POST:/claim-letters/search body → 200400404413429500502504
POST
/claim-letters/download
Download the full claim letter document for a claimant.
POST:/claim-letters/download body → 200400404413429500502504
GET
/uploads/{requestId}/status
Returns the processing status of a single disability claim document upload.
GET:/uploads/{requestId}/status 2 params → 200400404413429500502504

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are ClaimLetterDocumentV1 (9 properties), UploadRequestV1.UploadData (8 properties), VbmsDocumentV1 (8 properties), ClaimDocumentV1 (7 properties). Each schema is shown below with its type and property counts.

VbmsDownloadDocumentRequestV1.DocumentInfo
object
3 properties 1 required
UploadResponseV1.UploadInfo
object
2 properties 2 required
ValidateUploadClaimantRequestV1
object
1 property
ClaimantValidationResponseV1
object
1 property 1 required
BasicErrorDocumentV1
object
An error response in JSON:API format (see https://jsonapi.org/format/document-structure).
1 property 1 required
VbmsDownloadDocumentRequestV1
object
1 property 1 required
VbmsSearchDocumentsRequestV1
object
2 properties
ClaimDocumentV1
object
7 properties 6 required
UploadRequestV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusV1
object
The asynchronous processing workflow status of a single upload request.
5 properties 4 required
ClaimantValidationResponseV1.ValidationResult
object
3 properties 1 required
VbmsDocumentV1
object
8 properties
FindClaimLetterDocumentsRequestV1
object
1 property 1 required
DownloadClaimLetterDocumentRequestV1.ClaimLetterDocumentInfo
object
3 properties 1 required
ClaimDocumentsResponseV1.Documents
object
1 property
ClaimLetterDocumentV1
object
9 properties 7 required
VbmsSearchDocumentsResponseV1.Documents
object
1 property
Pagination
object
2 properties
ClaimDocumentsResponseV1
object
1 property 1 required
FindClaimLetterDocumentsRequestV1.FindClaimLetterDocumentsData
object
3 properties
UploadRequestAsyncProcessingStatusV1.WorkflowTime
object
Workflow timing information.
2 properties
ValidateUploadClaimantRequestV1.ValidateUploadData
object
4 properties 1 required
ClaimantValidationResponseV1.ValidationError
object
1 property 1 required
BasicErrorV1
object
API invocation or processing error
6 properties
ClaimantValidationResponseV1.ValidationSuccess
object
2 properties 2 required
ClaimDocumentsRequestV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusBulkResponseV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusResponseV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusV1.Step
object
The description of a single workflow step.
4 properties
FindClaimLetterDocumentsResponseV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusV1.WorkflowError
object
Workflow error information.
2 properties
UploadResponseV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusBulkResponseV1.UploadRequestStatuses
object
2 properties 1 required
UploadRequestV1.UploadData
object
8 properties 4 required
UploadRequestAsyncProcessingStatusBulkRequestV1.UploadRequestIds
object
1 property 1 required
VbmsSearchDocumentsResponseV1
object
2 properties 1 required
DownloadClaimLetterDocumentRequestV1
object
1 property 1 required
UploadRequestAsyncProcessingStatusBulkRequestV1
object
Requests the asynchronous processing status of more than one document upload request.
1 property 1 required
FindClaimLetterDocumentsResponseV1.ClaimLetterDocuments
object
1 property
ClaimDocumentsRequestV1.ClaimDocuments
object
3 properties 1 required
VbmsDocumentsIdentifier
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

va-gov-documents-service-api-openapi.yml Raw ↑

Other APIs VA Lighthouse publishes across the network.

Decision Reviews API
Education Benefits API
Loan Guaranty API
Guaranty Remittance API
Health Care Costs Coverage API
VA Lighthouse 5103 Waiver API
VA Lighthouse ACA Coverage API
VA Lighthouse AddressValidation-v3 API
VA Lighthouse Appealable Issues API
VA Lighthouse Appeals Status API
VA Lighthouse Claims API
VA Lighthouse DirectDeposit API
Where this information came from

This is an independent, third-party profile of VA Lighthouse Documents Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.