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.

Sign up for GitHub

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

Jump to bottom

Docs: Veterans use case #1731

Closed
wants to merge 1 commit into from
Closed

Docs: Veterans use case #1731

wants to merge 1 commit into from

Conversation

machikoyasuda
Copy link
Member

@machikoyasuda machikoyasuda commented Sep 19, 2023 •
edited
Loading

closes #1587

@github-actions github-actions bot added the documentation [auto] Improvements or additions to documentation label Sep 19, 2023
machikoyasuda
machikoyasuda commented Sep 19, 2023
View reviewed changes
docs/use-cases/veterans.md
Comment on lines +5 to +26
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.

## 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
```
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.

machikoyasuda
machikoyasuda commented Sep 19, 2023
View reviewed changes
docs/use-cases/veterans.md

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.

@machikoyasuda machikoyasuda marked this pull request as ready for review September 19, 2023 18:13
@machikoyasuda machikoyasuda requested a review from a team as a code owner September 19, 2023 18:13
@thekaveman
Copy link
Member

@indexing please coordinate with @machikoyasuda on the diagram you were creating last week, and this documentation for the Veteran use case.

@thekaveman thekaveman requested a review from indexing September 19, 2023 18:27
@machikoyasuda
Copy link
Member Author

@indexing here's the diagram visually: https://github.com/cal-itp/benefits/pull/1731/files?short_path=f8c3f59#diff-f8c3f5913b1bb71baaf34ba792e6011ef91b0617c0be5cf8cffdd0a445f528c5

and the code that makes it is here: https://github.com/cal-itp/benefits/pull/1731/files#diff-f8c3f5913b1bb71baaf34ba792e6011ef91b0617c0be5cf8cffdd0a445f528c5R9-R26

@angela-tran angela-tran mentioned this pull request Sep 22, 2023
Closed
@machikoyasuda
Copy link
Member Author

closing in favor of #1748

@machikoyasuda machikoyasuda deleted the docs/1587-veterans-use-case branch September 27, 2023 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@indexing indexing Awaiting requested review from indexing

Assignees
No one assigned
Labels
documentation [auto] Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update docs site with Veteran use case
2 participants
@machikoyasuda @thekaveman