LG-12080: Error Messages for Facematch Fail

app/javascript/packages/document-capture/components/document-capture-review-issues.tsx

@@ -16,6 +16,7 @@ import {
 import type { ReviewIssuesStepValue } from './review-issues-step';
 
 interface DocumentCaptureReviewIssuesProps extends FormStepComponentProps<ReviewIssuesStepValue> {
+  isFailedSelfie: boolean;
   isFailedDocType: boolean;
   isFailedSelfieLivenessOrQuality: boolean;
   remainingSubmitAttempts: number;
@@ -25,6 +26,7 @@ interface DocumentCaptureReviewIssuesProps extends FormStepComponentProps<Review
 
 function DocumentCaptureReviewIssues({
   isFailedDocType,
+  isFailedSelfie,
   isFailedSelfieLivenessOrQuality,
   remainingSubmitAttempts = Infinity,
   captureHints,
@@ -54,6 +56,7 @@ function DocumentCaptureReviewIssues({
         unknownFieldErrors={unknownFieldErrors}
         remainingSubmitAttempts={remainingSubmitAttempts}
         isFailedDocType={isFailedDocType}
+        isFailedSelfie={isFailedSelfie}
         isFailedSelfieLivenessOrQuality={isFailedSelfieLivenessOrQuality}
         altIsFailedSelfieDontIncludeAttempts
         altFailedDocTypeMsg={isFailedDocType ? t('doc_auth.errors.doc.wrong_id_type_html') : null}

app/javascript/packages/document-capture/components/document-capture-warning.tsx

@@ -12,6 +12,7 @@ import AnalyticsContext from '../context/analytics';
 interface DocumentCaptureWarningProps {
   isFailedDocType: boolean;
   isFailedResult: boolean;
+  isFailedSelfie: boolean;
   isFailedSelfieLivenessOrQuality: boolean;
   remainingSubmitAttempts: number;
   actionOnClick?: () => void;
@@ -23,22 +24,51 @@ const DISPLAY_ATTEMPTS = 3;
 
 type GetHeadingArguments = {
   isFailedDocType: boolean;
+  isFailedSelfie: boolean;
   isFailedSelfieLivenessOrQuality: boolean;
   t: typeof I18n.prototype.t;
 };
-function getHeading({ isFailedDocType, isFailedSelfieLivenessOrQuality, t }: GetHeadingArguments) {
+function getHeading({
+  isFailedDocType,
+  isFailedSelfie,
+  isFailedSelfieLivenessOrQuality,
+  t,
+}: GetHeadingArguments) {
   if (isFailedDocType) {
     return t('errors.doc_auth.doc_type_not_supported_heading');
   }
   if (isFailedSelfieLivenessOrQuality) {
     return t('errors.doc_auth.selfie_not_live_or_poor_quality_heading');
   }
+  if (isFailedSelfie) {
+    return t('errors.doc_auth.selfie_fail_heading');
+  }
   return t('errors.doc_auth.rate_limited_heading');
 }
 
+function getSubheading({
+  nonIppOrFailedResult,
+  isFailedDocType,
+  isFailedSelfieLivenessOrQuality,
+  isFailedSelfie,
+  t,
+}) {
+  const showSubheading =
+    !nonIppOrFailedResult &&
+    !isFailedDocType &&
+    !isFailedSelfieLivenessOrQuality &&
+    !isFailedSelfie;
+
+  if (showSubheading) {
+    return <h2>{t('errors.doc_auth.rate_limited_subheading')}</h2>;
+  }
+  return undefined;
+}
+
 function DocumentCaptureWarning({
   isFailedDocType,
   isFailedResult,
+  isFailedSelfie,
   isFailedSelfieLivenessOrQuality,
   remainingSubmitAttempts,
   actionOnClick,
@@ -50,13 +80,22 @@ function DocumentCaptureWarning({
   const { trackEvent } = useContext(AnalyticsContext);
 
   const nonIppOrFailedResult = !inPersonURL || isFailedResult;
-  const heading = getHeading({ isFailedDocType, isFailedSelfieLivenessOrQuality, t });
+  const heading = getHeading({
+    isFailedDocType,
+    isFailedSelfie,
+    isFailedSelfieLivenessOrQuality,
+    t,
+  });
   const actionText = nonIppOrFailedResult
     ? t('idv.failure.button.warning')
     : t('idv.failure.button.try_online');
-  const subheading = !nonIppOrFailedResult &&
-    !isFailedDocType &&
-    !isFailedSelfieLivenessOrQuality && <h2>{t('errors.doc_auth.rate_limited_subheading')}</h2>;
+  const subheading = getSubheading({
+    nonIppOrFailedResult,
+    isFailedDocType,
+    isFailedSelfieLivenessOrQuality,
+    isFailedSelfie,
+    t,
+  });
   const subheadingRef = useRef<HTMLDivElement>(null);
   const errorMessageDisplayedRef = useRef<HTMLDivElement>(null);
 
@@ -95,12 +134,14 @@ function DocumentCaptureWarning({
             unknownFieldErrors={unknownFieldErrors}
             remainingSubmitAttempts={remainingSubmitAttempts}
             isFailedDocType={isFailedDocType}
+            isFailedSelfie={isFailedSelfie}
             isFailedSelfieLivenessOrQuality={isFailedSelfieLivenessOrQuality}
             hasDismissed={hasDismissed}
           />
         </div>
 
         {!isFailedDocType &&
+          !isFailedSelfie &&
           !isFailedSelfieLivenessOrQuality &&
           remainingSubmitAttempts <= DISPLAY_ATTEMPTS && (
             <p>

app/javascript/packages/document-capture/components/document-capture.tsx

@@ -114,6 +114,7 @@ function DocumentCapture({ onStepChange = () => {} }: DocumentCaptureProps) {
                 ? withProps({
                     remainingSubmitAttempts: submissionError.remainingSubmitAttempts,
                     isFailedResult: submissionError.isFailedResult,
+                    isFailedSelfie: submissionError.isFailedSelfie,
                     isFailedDocType: submissionError.isFailedDocType,
                     isFailedSelfieLivenessOrQuality:
                       submissionError.selfieNotLive || submissionError.selfieNotGoodQuality,

app/javascript/packages/document-capture/components/review-issues-step.tsx

@@ -38,6 +38,7 @@ export interface ReviewIssuesStepValue {
 interface ReviewIssuesStepProps extends FormStepComponentProps<ReviewIssuesStepValue> {
   remainingSubmitAttempts?: number;
   isFailedResult?: boolean;
+  isFailedSelfie?: boolean;
   isFailedDocType?: boolean;
   isFailedSelfieLivenessOrQuality?: boolean;
   captureHints?: boolean;
@@ -56,6 +57,7 @@ function ReviewIssuesStep({
   remainingSubmitAttempts = Infinity,
   isFailedResult = false,
   isFailedDocType = false,
+  isFailedSelfie = false,
   isFailedSelfieLivenessOrQuality = false,
   pii,
   captureHints = false,
@@ -120,6 +122,7 @@ function ReviewIssuesStep({
       <DocumentCaptureWarning
         isFailedDocType={isFailedDocType}
         isFailedResult={isFailedResult}
+        isFailedSelfie={isFailedSelfie}
         isFailedSelfieLivenessOrQuality={isFailedSelfieLivenessOrQuality}
         remainingSubmitAttempts={remainingSubmitAttempts}
         unknownFieldErrors={unknownFieldErrors}
@@ -131,6 +134,7 @@ function ReviewIssuesStep({
   // Show review issue screen, hasDismissed = true
   return (
     <DocumentCaptureReviewIssues
+      isFailedSelfie={isFailedSelfie}
       isFailedDocType={isFailedDocType}
       isFailedSelfieLivenessOrQuality={isFailedSelfieLivenessOrQuality}
       remainingSubmitAttempts={remainingSubmitAttempts}

app/javascript/packages/document-capture/components/unknown-error.tsx

@@ -9,6 +9,7 @@ import MarketingSiteContext from '../context/marketing-site';
 interface UnknownErrorProps extends ComponentProps<'p'> {
   unknownFieldErrors: FormStepError<{ front: string; back: string }>[];
   isFailedDocType: boolean;
+  isFailedSelfie: boolean;
   isFailedSelfieLivenessOrQuality: boolean;
   remainingSubmitAttempts: number;
   altFailedDocTypeMsg?: string | null;
@@ -43,6 +44,7 @@ function getError({ unknownFieldErrors }: GetErrorArguments) {
 function UnknownError({
   unknownFieldErrors = [],
   isFailedDocType = false,
+  isFailedSelfie = false,
   isFailedSelfieLivenessOrQuality = false,
   remainingSubmitAttempts,
   altFailedDocTypeMsg = null,
@@ -80,7 +82,7 @@ function UnknownError({
       </p>
     );
   }
-  if (isFailedSelfieLivenessOrQuality && err) {
+  if ((isFailedSelfieLivenessOrQuality || isFailedSelfie) && err) {
     return (
       <>
         <p>{err.message}</p>

app/javascript/packages/document-capture/context/upload.tsx

@@ -95,6 +95,11 @@ export interface UploadErrorResponse {
    */
   result_failed: boolean;
 
+  /**
+   * Whether the selfie captured matched the image on the id.
+   */
+  selfie_status?: string;
+
   /**
    * Whether the doc type is clearly not supported type.
    */

app/javascript/packages/document-capture/services/upload.ts

@@ -42,6 +42,8 @@ export class UploadFormEntriesError extends FormError {
 
   isFailedDocType = false;
 
+  isFailedSelfie = false;
+
   selfieNotLive = false;
 
   selfieNotGoodQuality = false;
@@ -126,6 +128,8 @@ const upload: UploadImplementation = async function (payload, { method = 'POST',
 
     error.isFailedResult = !!result.result_failed;
 
+    error.isFailedSelfie = result.selfie_status === 'fail';
+
     error.isFailedDocType = !result.doc_type_supported;
 
     error.selfieNotLive = result.selfie_live === undefined ? false : !result.selfie_live;

app/services/doc_auth/error_generator.rb

@@ -71,7 +71,24 @@ def generate_doc_auth_errors(response_info)
       image_metric_errors = get_image_metric_errors(response_info[:image_metrics])
       return image_metric_errors.to_h unless image_metric_errors.empty?
 
+      # If we have a selfie failure (selfie does not match id), then all three fields:
+      # front, back, and selfie should fail with specific in line errors.
       liveness_enabled = response_info[:liveness_enabled]
+      selfie_error = get_selfie_error(liveness_enabled, response_info)
+      if selfie_error == Errors::SELFIE_FAILURE
+        # This returns the same sort of object that ErrorResult.to_h returns
+        # but we need to do something more complex than that's set up to handle
+        return {
+          general: [Errors::SELFIE_NOT_LIVE],
+          front: [Errors::MULTIPLE_FRONT_ID_FAILURES],
+          back: [Errors::MULTIPLE_BACK_ID_FAILURES],
+          selfie: [Errors::SELFIE_FAILURE],
+          hints: false,
+        }
+      end
+
+      # This block can also return errors for front, back, and/or selfie
+      # But we only get here if none of the returns above are triggered
       alert_errors = get_error_messages(liveness_enabled, response_info)
       alert_error_count += 1 if alert_errors.include?(SELFIE)
 

app/services/doc_auth/errors.rb

@@ -29,7 +29,6 @@ module Errors
     SELFIE_FAILURE = 'selfie_failure'
     SELFIE_NOT_LIVE = 'selfie_not_live'
     SELFIE_POOR_QUALITY = 'selfie_poor_quality'
-    SELFIE_NOT_LIVE_POOR_QUALITY_FIELD = 'selfie_not_live_poor_quality'
     SEX_CHECK = 'sex_check'
     VISIBLE_COLOR_CHECK = 'visible_color_check'
     VISIBLE_PHOTO_CHECK = 'visible_photo_check'
@@ -114,15 +113,14 @@ module Errors
       VISIBLE_PHOTO_CHECK => { long_msg: VISIBLE_PHOTO_CHECK, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
       SEX_CHECK => { long_msg: SEX_CHECK, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
       VISIBLE_COLOR_CHECK => { long_msg: VISIBLE_COLOR_CHECK, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
-      # Multiple Errors
+      # Multiple errors
       MULTIPLE_FRONT_ID_FAILURES => { long_msg: MULTIPLE_FRONT_ID_FAILURES, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
       MULTIPLE_BACK_ID_FAILURES => { long_msg: MULTIPLE_BACK_ID_FAILURES, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
       GENERAL_ERROR => { long_msg: GENERAL_ERROR, field_msg: FALLBACK_FIELD_LEVEL, hints: true },
-      # TODO, theses messages need modifying
-      # Liveness, use general error for now
-      SELFIE_FAILURE => { long_msg: GENERAL_ERROR, field_msg: FALLBACK_FIELD_LEVEL, hints: false },
-      SELFIE_NOT_LIVE => { long_msg: SELFIE_NOT_LIVE, field_msg: SELFIE_NOT_LIVE_POOR_QUALITY_FIELD, hints: false },
-      SELFIE_POOR_QUALITY => { long_msg: SELFIE_POOR_QUALITY, field_msg: SELFIE_NOT_LIVE_POOR_QUALITY_FIELD, hints: false },
+      # Selfie errors
+      SELFIE_FAILURE => { long_msg: SELFIE_FAILURE, field_msg: SELFIE_FAILURE, hints: false },
+      SELFIE_NOT_LIVE => { long_msg: SELFIE_NOT_LIVE, field_msg: SELFIE_FAILURE, hints: false },
+      SELFIE_POOR_QUALITY => { long_msg: SELFIE_POOR_QUALITY, field_msg: SELFIE_FAILURE, hints: false },
     }
     # rubocop:enable Layout/LineLength
   end

app/services/doc_auth_router.rb

@@ -54,13 +54,12 @@ module DocAuthRouter
     # i18n-tasks-use t('doc_auth.errors.alerts.ref_control_number_check')
     DocAuth::Errors::REF_CONTROL_NUMBER_CHECK =>
       'doc_auth.errors.alerts.ref_control_number_check',
+    # i18n-tasks-use t('doc_auth.errors.general.selfie_failure')
+    DocAuth::Errors::SELFIE_FAILURE => 'doc_auth.errors.general.selfie_failure',
     # i18n-tasks-use t('doc_auth.errors.alerts.selfie_not_live')
     DocAuth::Errors::SELFIE_NOT_LIVE => 'doc_auth.errors.alerts.selfie_not_live',
     # i18n-tasks-use t('doc_auth.errors.alerts.selfie_poor_quality')
     DocAuth::Errors::SELFIE_POOR_QUALITY => 'doc_auth.errors.alerts.selfie_poor_quality',
-    # i18n-tasks-use t('doc_auth.errors.alerts.selfie_not_live_poor_quality')
-    DocAuth::Errors::SELFIE_NOT_LIVE_POOR_QUALITY_FIELD =>
-      'doc_auth.errors.alerts.selfie_not_live_poor_quality',
     # i18n-tasks-use t('doc_auth.errors.alerts.sex_check')
     DocAuth::Errors::SEX_CHECK => 'doc_auth.errors.alerts.sex_check',
     # i18n-tasks-use t('doc_auth.errors.alerts.visible_color_check')

config/locales/doc_auth/en.yml

@@ -40,7 +40,6 @@ en:
         ref_control_number_check: We couldn’t read the control number barcode. Try taking new pictures.
         selfie_not_live: 'Try taking a photo of yourself again. Make sure your whole
           face is clear and visible in the photo.'
-        selfie_not_live_poor_quality: 'We couldn’t verify the photo of yourself. Try taking a new picture.'
         selfie_poor_quality: 'Try taking a photo of yourself again. Make sure your whole
           face is clear and visible in the photo.'
         sex_check: We couldn’t read the sex on your ID. Try taking new pictures.
@@ -85,6 +84,7 @@ en:
         network_error: We are having technical difficulties on our end. Please try to
           submit your images again later.
         no_liveness: Try taking new pictures.
+        selfie_failure: We couldn’t verify the photo of yourself. Try taking a new picture.
       glare:
         failed_short: Image has glare, please try again.
         top_msg: We couldn’t read your ID. Your photo may have glare. Make sure that the

config/locales/doc_auth/es.yml

@@ -50,7 +50,6 @@ es:
           control. Intente tomar nuevas fotografías.
         selfie_not_live: 'Intenta volver a tomarte una foto. Asegúrate de que tu rostro
           completo esté claro y visible en la foto.'
-        selfie_not_live_poor_quality: 'No pudimos verificar su foto. Trate de tomarse otra foto.'
         selfie_poor_quality: 'Intenta volver a tomarte una foto. Asegúrate de que tu
           rostro completo esté claro y visible en la foto.'
         sex_check: No pudimos leer el sexo en su documento de identidad. Intente tomar
@@ -108,6 +107,7 @@ es:
         network_error: Estamos teniendo problemas técnicos por nuestra parte. Intente
           enviar sus imágenes de nuevo más tarde.
         no_liveness: Intente tomar nuevas fotografías.
+        selfie_failure: No pudimos verificar su foto. Trate de tomarse otra foto.
       glare:
         failed_short: Hay reflejos en la imagen, por favor inténtelo de nuevo.
         top_msg: No pudimos leer su identificación. Es posible que su foto tenga

config/locales/doc_auth/fr.yml

@@ -53,8 +53,6 @@ fr:
           contrôle. Essayez de prendre de nouvelles photos.
         selfie_not_live: 'Rééssayez de vous prendre en photo. Assurez-vous que lensemble
           de votre visage est clair et visible sur la photo.'
-        selfie_not_live_poor_quality: 'Nous n’avons pas réussi à vérifier votre photo.
-          Essayez à nouveau avec une nouvelle photo.'
         selfie_poor_quality: 'Rééssayez de vous prendre en photo. Assurez-vous que
           l’ensemble de votre visage est clair et visible sur la photo.'
         sex_check: Nous n’avons pas pu lire le sexe sur votre pièce d’identité. Essayez
@@ -114,6 +112,8 @@ fr:
         network_error: Nous avons des difficultés techniques de notre côté. Veuillez
           essayer de soumettre à nouveau vos images plus tard.
         no_liveness: Essayez de prendre de nouvelles photos.
+        selfie_failure: Nous n’avons pas réussi à vérifier votre photo. Essayez à
+          nouveau avec une nouvelle photo.
       glare:
         failed_short: L’image a des reflets, veuillez réessayer.
         top_msg: Nous n’avons pas pu lire votre pièce d’identité. Votre photo peut avoir

config/locales/errors/en.yml

@@ -34,6 +34,7 @@ en:
       rate_limited_text_html: 'For your security, we limit the number of times you can
         attempt to verify a document online. <strong>Try again in
         %{timeout}.</strong>'
+      selfie_fail_heading: We couldn’t match the photo of yourself to your ID
       selfie_not_live_or_poor_quality_heading: We could not verify the photo of yourself
       send_link_limited: You tried too many times, please try again in %{timeout}. You
         can also go back and choose to use your computer instead.

config/locales/errors/es.yml

@@ -36,6 +36,7 @@ es:
       rate_limited_text_html: 'Por su seguridad, limitamos el número de veces que
         puede intentar verificar un documento en línea. <strong>Inténtelo de
         nuevo en %{timeout}.</strong>'
+      selfie_fail_heading: No pudimos cotejar tu foto con tu identificación
       selfie_not_live_or_poor_quality_heading: No pudimos verificar tu foto
       send_link_limited: Ha intentado demasiadas veces, por favor, inténtelo de nuevo
         en %{timeout}. También puede retroceder y elegir utilizar su computadora

config/locales/errors/fr.yml

@@ -40,6 +40,8 @@ fr:
       rate_limited_text_html: 'Pour votre sécurité, nous limitons le nombre de fois où
         vous pouvez tenter de vérifier un document en ligne. <strong>Veuillez
         réessayer dans %{timeout}.</strong>'
+      selfie_fail_heading: Nous n’avons pas pu faire correspondre votre photo à votre
+        pièce d’identité
       selfie_not_live_or_poor_quality_heading: Nous n’avons pas pu vérifier votre photo
       send_link_limited: Vous avez essayé trop de fois, veuillez réessayer dans
         %{timeout}. Vous pouvez également revenir en arrière et choisir