LG-15217 Add submit_attempts property to doc auth troubleshooting option actions #11682
Conversation
…shooting_option_clicked and idv_capture_troubleshooting_dismissed changelog: Internal, In-person proofing, add submit_attempts property to try again and IPP fallback doc auth troubleshooting events
📓 Testing Notes:❓If a user starts over, should the count start over? It makes sense that is does not start over- your comments say user so I bet not but just checking |
| @@ -80,6 +81,11 @@ export interface UploadErrorResponse { | |||
| */ | |||
| remaining_submit_attempts?: number; | |||
|
|
|||
| /** | |||
| * Number of submit attempts for user. | |||
There was a problem hiding this comment.
Number of doc auth submit attempts for user
| @@ -1198,12 +1198,14 @@ def idv_cancellation_visited( | |||
| # @param ["hybrid","standard"] flow_path Document capture user flow | |||
| # @param [String] use_alternate_sdk | |||
| # @param [Boolean] liveness_checking_required | |||
| # @param [Integer] submit_attempts Times that user has tried submitting | |||
There was a problem hiding this comment.
Maybe try... number of doc auth submit_attempts for user
| @@ -5268,16 +5271,19 @@ def idv_verify_by_mail_enter_code_visited( | |||
|
|
|||
| # @param ["hybrid","standard"] flow_path Document capture user flow | |||
| # @param [Boolean] opted_in_to_in_person_proofing User opted into in person proofing | |||
| # @param [Integer] submit_attempts Times that user has tried submitting | |||
| # The user clicked the troubleshooting option to start in-person proofing | |||
There was a problem hiding this comment.
If you update the description above, maybe do so here too
🎫 Ticket
Link to the relevant ticket:
LG-15217
🛠 Summary of changes
We want to be able to track metrics for users who choose to "try again online" or fall back to "try in person" after not being able to verify their ID in the remote flow. In particular we want to know how many submission attempts they've made before eventually trying in person. This PR adds
submit_attemptsto the analytics for these events: "Frontend: IdV: Capture troubleshooting dismissed" and "Frontend: IdV: Capture troubleshooting dismissed"📜 Testing Plan
Provide a checklist of steps to confirm the changes.
Run
make watch_eventsin your terminal to view the analytics eventsEnter the application through Sinatra, choosing "identity-verified"
Begin the remote flow by choosing "Continue online" on /verify/how_to_verify
Choose "upload photos" to reach the document capture step
Upload failing images and submit
Choose "Try Again"
Observe that the event "Frontend: IdV: Capture troubleshooting dismissed" has been logged, with
submit_attemptsincluded under event_properties. It should accurately reflect how many times you've tried to submit the doc. (So far, 1)Back on the document capture page, upload another erroring/failing ID (you may need a separate failing YML or reload the page to upload the same ones you just uploaded)
This time, choose "Try in person"
Observe that the event "IdV: verify in person troubleshooting option clicked" has been logged, with
submit_attemptsincluded under event_properties. It should accurately reflect how many times you've tried to submit the doc (This time, 2)👀 Screenshots
Screen.Recording.2024-12-20.at.11.17.17.AM.mov