Skip to content

Commit

Permalink
Updating Benefits Documentation (#3353)
Browse files Browse the repository at this point in the history
* Updating Benefits Documentation

* minor claims support link addon
  • Loading branch information
bastosmichael committed Sep 28, 2019
1 parent 8e4216a commit b329f7e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
2 changes: 2 additions & 0 deletions modules/claims_api/app/swagger/claims_api/description/v0.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ Use this API to submit a Veteran's benefits claim, and to request the status of
The Benefit Claim API passes data through to Electronic Veterans Self Service, EVSS.

EVSS uses VAAFI to authenticate requests.

Visit our VA Lighthouse [support portal](https://developer.va.gov/support) for further assistance.
2 changes: 2 additions & 0 deletions modules/claims_api/app/swagger/claims_api/description/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The Benefit Claim API passes data through to Electronic Veterans Self Service, E

EVSS uses VAAFI to authenticate requests.

Visit our VA Lighthouse [support portal](https://developer.va.gov/support) for further assistance.

## Scopes
The Claims API utilizes the following scopes:
- claim.read
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@ The Benefits Intake API allows authorized third-party systems used by Veteran Se

This API provides a secure and efficient alternative to paper or fax document submissions. VBA can begin processing documents submitted through this API immediately, which ultimately allows VA to provide Veterans with claim decisions more quickly.

It also saves users time by reporting documents' status until they reach Veterans Benefits Management System (VBMS), where the documents are reviewed. This eliminates the need for users to switch between systems to manually check whether documents have reached VBMS.

Visit our VA Lighthouse [support portal](https://developer.va.gov/support) for further assistance.

## Technical Summary
The Benefits Intake API accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata. The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as multipart/form-data. A unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
The Benefits Intake API accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata. The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). A unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.

API consumers are encouraged to validate the `zipcode` and `fileNumber` fields before submission according to their description in the DocumentUploadMetadata model.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This API provides a secure and efficient alternative to paper or fax document su

It also saves users time by reporting documents' status until they reach Veterans Benefits Management System (VBMS), where the documents are reviewed. This eliminates the need for users to switch between systems to manually check whether documents have reached VBMS.

Visit our VA Lighthouse [support portal](https://developer.va.gov/support) for further assistance.

## Technical Summary
The Benefits Intake API accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata. The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). A unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.

Expand Down

0 comments on commit b329f7e

Please sign in to comment.