Skip to content

Commit 5a2e6e0

Browse files
committed
docs(logic): describe eligibility verification phase
1 parent 10546ef commit 5a2e6e0

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/development/application-logic.md

+46
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,57 @@ flowchart LR
141141

142142
## Eligibility verification
143143

144+
In this phase, Cal-ITP Benefits verifies the user's claims using one of two methods:
145+
146+
- Claims validation, using claims previously stored in the user's session during [Identity proofing](#identity-proofing)
147+
- Eligibility API verification, using non-PII claims provided by the user in an HTML form submission
148+
149+
!!! example "Entrypoint"
150+
151+
[`benefits/eligibility/views.py`][eligibility-views]
152+
153+
!!! example "Key supporting files"
154+
155+
[`benefits/eligibility/verify.py`][eligibility-verify]
156+
157+
```mermaid
158+
flowchart LR
159+
session[(session)]
160+
161+
start(("`Previous
162+
phase`"))
163+
style start stroke-dasharray: 5 5
164+
165+
claims[Session claims check]
166+
form[HTTP form POST]
167+
server[[Eligibility Verification server]]
168+
eligible{Eligible?}
169+
170+
next>"`_Enrollment_`"]
171+
style next stroke-width:2px
172+
173+
stop{{Stop}}
174+
175+
start -- Eligibility API verification --> form
176+
form -- Eligibility API call --> server
177+
server --> eligible
178+
179+
start -- Claims validation --> claims
180+
session -. read .-> claims
181+
claims --> eligible
182+
183+
eligible -- Yes --> next
184+
eligible -- No --> stop
185+
eligible -. update .-> session
186+
```
187+
144188
## Enrollment
145189

146190
[core-models]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/models.py
147191
[core-session]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/session.py
148192
[core-views]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/views.py
193+
[eligibility-verify]: https://github.com/cal-itp/benefits/blob/dev/benefits/eligibility/verify.py
194+
[eligibility-views]: https://github.com/cal-itp/benefits/blob/dev/benefits/eligibility/views.py
149195
[oauth-client]: https://github.com/cal-itp/benefits/blob/dev/benefits/oauth/client.py
150196
[oauth-redirects]: https://github.com/cal-itp/benefits/blob/dev/benefits/oauth/redirects.py
151197
[oauth-views]: https://github.com/cal-itp/benefits/blob/dev/benefits/oauth/views.py

0 commit comments

Comments
 (0)