Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Veterans use case #1731

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/use-cases/veterans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Veterans

Another use case for the Benefits application is for U.S. veterans - people who have served in the active military, naval, or air service, and who were discharged or released therefrom under conditions other than dishonorable. The Benefits application verifies the person's veteran status to confirm eligibility and allows those eligible to enroll their contactless payment card for their transit benefit.

On the back-end, the app uses the Identity Gateway to connect to the [Veteran Confirmation API](https://developer.va.gov/explore/api/veteran-confirmation) to confirm veteran status. On the front-end, users must create or log into their Login.gov account to complete the eligibility verification process.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I omitted the whole part about how we used to have DS Logon, ID.me, etc. I can add that when we get permission to do so.


## Process

```mermaid
sequenceDiagram
actor Rider
participant Benefits as Benefits app
participant IdG as Identity Gateway
participant VA as VA.gov Confirmation API
participant Littlepay

Rider->>Benefits: visits site
Benefits-->>IdG: identity proofing
IdG-->>VA: identity proofing
Rider->>VA: enters SSN and ID
VA-->>IdG: eligibility verification
IdG-->>Benefits: eligibility verification
Benefits-->>Littlepay: enrollment start
Rider->>Littlepay: enters payment card details
Littlepay-->>Benefits: enrollment complete
```
Comment on lines +5 to +26
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@angela-tran @thekaveman Is this characterized correctly? I wasn't sure if or where to add Login.gov to the Process Diagram.