Skip to content

Commit

Permalink
Add failure_reason
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sgtpluck
Sgtpluck committed Jan 7, 2025
1 parent b4e1e09 commit 4dc0d13
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 9 deletions.
47 changes: 43 additions & 4 deletions docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,49 @@ allOf:
properties:
pii:
type: array
# What is the best way of documenting all these errors? https://docs.google.com/document/d/1H7SAM8DSnbRJqKoSj4Qdzr-UvLCNMupt2zoqHLsIFe8/edit?tab=t.0#heading=h.uiomae9tgtly
# They won't be very readable in this document
description: |
Due to technical limitations, errors for this event will be localized into English, Spanish, or French, depending on the user’s settings, and appear in the “failure_reasons” setting that way.
description: |
Errors that describe the failure
items:
type: string
enum:
- We couldn't read the barcode on the back of your ID. It could be because of a problem with the barcode, or the barcode is a new type that we don't recognize yet. Use another state-issued ID if you have one.
- We couldn't read the barcode on the back of your ID. Try taking a new picture.
- We couldn't read the birth date on your ID. Try taking new pictures.
- We couldn't read the reference number on the back of your ID. Try taking a new picture.
- We couldn't recognize your ID. It may be worn or damaged, or the front and the back of the ID don't match. Try taking new pictures.
- We couldn't read the document number on your ID. Try taking new pictures.
- The document has expired, or we couldn't read the expiration date on your ID. If your ID is not expired, try taking new pictures.
- We couldn't read the full name on your ID. Try taking new pictures.
- We couldn't recognize your ID. It may be worn, damaged, or a type of ID that we don't recognize. Try taking new pictures.
- We couldn't verify your ID. It might have moved when you took the picture. Try taking new pictures.
- We couldn't read the issue date on your ID. Try taking new pictures.
- We couldn't read the control number barcode. Try taking new pictures.
- We couldn't read the sex on your ID. Try taking new pictures.
- We couldn't verify your ID. It might have moved when you took the picture, or the picture is too dark. Try taking new pictures in brighter lighting.
- We couldn't verify the photo on your ID. Try taking new pictures.
- If the information below is incorrect, please upload new photos of your state-issued ID.
- We couldn't read the barcode on your ID.
- Your camera is blocked
- We don't have permission to access the camera. Please check your browser or system settings, reload this page, or upload a photo instead.
- Camera failed to start, please try again.
- Image is too small or blurry, please try again.
- We couldn't read your ID. Your image sizes may be too small, or your ID is too small or blurry in the photos. Make sure your ID is large within the image frame and try taking new pictures.
- This file type is not accepted, please choose a JPG or PNG file.
- Please add a new image
- We couldn't verify the back of your ID. Try taking a new picture.
- We couldn't verify the front of your ID. Try taking a new picture.
- We are having technical difficulties on our end. Please try to submit your images again later.
- Try taking new pictures.
- Image has glare, please try again.
- We couldn't read your ID. Your photos may have glare. Make sure that the flash on your camera is off and try taking new pictures.
- The image file that you added is not supported. Please take new photos of your ID and try again.
- Your image size is too large or too small. Please add images of your ID that are about 2025 x 1275 pixels.
- The pixel depth of your image file is not supported. Please take new photos of your ID and try again. Supported image pixel depth is 24-bit RGB.
- To continue, sign in to your Login.gov account on any device that has a camera, like a mobile phone, tablet or computer with a webcam.
- The selection was not a valid file.
- Your birthday does not meet the minimum age requirement.
- Image is blurry, please try again.
- We couldn't read your ID. Your photos may be too blurry or dark. Try taking new pictures in a bright area.
success:
type: boolean
description: |
Expand Down
23 changes: 18 additions & 5 deletions docs/attempts-api/schemas/events/identity-proofing/IdvPhoneOtpSent.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,24 @@ allOf:
properties:
telephony_errors:
type: array
# What is the best way of documenting all these errors? https://docs.google.com/document/d/1H7SAM8DSnbRJqKoSj4Qdzr-UvLCNMupt2zoqHLsIFe8/edit?tab=t.0#heading=h.obq86kcsheu4
# They won't be very readable in this document
description: |
Due to technical limitations, errors for this event will be localized into English, Spanish, or French, depending on the user’s settings, and appear in the “failure_reasons” setting that way.
description: Errors that describe the failure
items:
type: string
enum:
- daily_voice_limit_reached
- duplicate_endpoint
- generic
- invalid_calling_area
- invalid_phone_number
- opt_out
- permanent_failure
- sms_unsupported
- temporary_failure
- throttled
- timeout
- unknown_failure
- voice_unsupported
success:
type: boolean
description: |
Indicates whether the backup codes were successfully generated
Indicates whether the backup codes were successfully generated

0 comments on commit 4dc0d13

Please sign in to comment.