From 719a62505148c424caabbc0754f35e0a6be1bdcd Mon Sep 17 00:00:00 2001 From: Davida Marion Date: Wed, 20 Aug 2025 16:05:23 -0400 Subject: [PATCH] changelog: Internal, Documentation, Add missing elements from Attempts API Event documentation --- docs/attempts-api/schemas/events/IdentityProofingEvents.yml | 2 ++ .../events/identity-proofing/IdvDocumentUploadSubmitted.yml | 6 ++++++ .../events/identity-proofing/IdvDocumentUploaded.yml | 6 ++++++ 3 files changed, 14 insertions(+) diff --git a/docs/attempts-api/schemas/events/IdentityProofingEvents.yml b/docs/attempts-api/schemas/events/IdentityProofingEvents.yml index b27d98593c8..8ec2b4367f5 100644 --- a/docs/attempts-api/schemas/events/IdentityProofingEvents.yml +++ b/docs/attempts-api/schemas/events/IdentityProofingEvents.yml @@ -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: diff --git a/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml b/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml index 285e294d439..c372acc27d6 100644 --- a/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml +++ b/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploadSubmitted.yml @@ -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 @@ -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. diff --git a/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploaded.yml b/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploaded.yml index 2b906b8363b..6ac45cf458c 100644 --- a/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploaded.yml +++ b/docs/attempts-api/schemas/events/identity-proofing/IdvDocumentUploaded.yml @@ -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 @@ -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.