Skip to content

Add missing elements from Attempts API Event documentation #12441

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

Merged
Sgtpluck merged 1 commit into from
Aug 21, 2025
Merged

Add missing elements from Attempts API Event documentation #12441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/attempts-api/schemas/events/IdentityProofingEvents.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ properties:
$ref: './identity-proofing/IdvEnrollmentComplete.yml'
idv-ipp-ready-to-verify-visit:
$ref: './identity-proofing/IdvIppReadyToVerifyVisit.yml'
idv-image-retrieval-failed:
$ref: './identity-proofing/IdvImageRetrievalFailed.yml'
idv-phone-otp-sent:
$ref: './identity-proofing/IdvPhoneOtpSent.yml'
idv-phone-otp-submitted:
Expand Down
6 changes: 6 additions & 0 deletions docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ allOf:
document_back_image_file_id:
type: string
description: The ID used to retrieve this image if needed
document_passport_image_file_id:
type: string
description: The ID used to retrieve this image if needed
document_selfie_image_file_id:
type: string
description: The ID used to retrieve this image if needed
Expand All @@ -49,6 +52,9 @@ allOf:
document_back_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the back image file.
document_passport_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the passport image file if it exists.
document_selfie_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the selfie image file if it exists.
Expand Down
6 changes: 6 additions & 0 deletions docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploaded.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ allOf:
document_back_image_file_id:
type: string
description: If this image exists, the ID used to retrieve it if needed
document_passport_image_file_id:
type: string
description: If this image exists, the ID used to retrieve it if needed
document_selfie_image_file_id:
type: string
description: If this image exists, the ID used to retrieve it if needed
Expand All @@ -19,6 +22,9 @@ allOf:
document_back_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the back image file if it exists.
document_passport_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the passport image file if it exists.
document_selfie_image_encryption_key:
type: string
description: Randomly generated Base64-encoded key used to encrypt the selfie image file if it exists.
Expand Down