SDK-2617 IDV session SDK configuration with suppressed screens (#538)

* Added optional 'suppressed_screens' in the IDV session SDK configuration.

* Fix JSDOC description

* Added example for the suppressed screens option.

Author: laurent-yoti

examples/idv/src/controllers/use-cases/index.js

@@ -5,6 +5,7 @@ const allowExpiredDocumentCheckController = require('./allow.expired.document.ch
 const faceComparisonCheckController = require('./face.comparison.check.controller');
 const faceMatchCheckController = require('./face.match.check.controller');
 const watchlistCheckController = require('./watchlist.check.controller');
+const suppressedScreensCheckController = require('./suppressed.screens.check.controller');
 
 module.exports = {
   authenticityAndIdentityCheckController,
@@ -14,4 +15,5 @@ module.exports = {
   faceComparisonCheckController,
   faceMatchCheckController,
   watchlistCheckController,
+  suppressedScreensCheckController,
 };

examples/idv/src/controllers/use-cases/suppressed.screens.check.controller.js

@@ -0,0 +1,77 @@
+const {
+  IDVClient,
+  SessionSpecificationBuilder,
+  SdkConfigBuilder,
+  RequiredIdDocumentBuilder,
+  RequestedDocumentAuthenticityCheckBuilder,
+  RequestedTextExtractionTaskBuilder,
+} = require('yoti');
+const config = require('../../../config');
+
+/**
+ * Create an IDV session.
+ */
+async function createSession() {
+  const idvClient = new IDVClient(
+    config.YOTI_CLIENT_SDK_ID,
+    config.YOTI_PEM
+  );
+
+  const sessionSpec = new SessionSpecificationBuilder()
+    .withClientSessionTokenTtl(600) // 10 minutes
+    .withResourcesTtl(90000) // session TTL(10 minutes) + 24 hours(minimum required)
+    .withUserTrackingId('some-user-tracking-id')
+    .withRequestedCheck(
+      new RequestedDocumentAuthenticityCheckBuilder()
+        .withManualCheckFallback()
+        .build()
+    )
+    .withRequestedTask(
+      new RequestedTextExtractionTaskBuilder()
+        .withManualCheckFallback()
+        .withChipDataDesired()
+        .withCreateExpandedDocumentFields(true) // default is false
+        .build()
+    )
+    .withSdkConfig(
+      new SdkConfigBuilder()
+        .withAllowsCameraAndUpload()
+        .withPrimaryColour('#2d9fff')
+        .withSecondaryColour('#FFFFFF')
+        .withFontColour('#FFFFFF')
+        .withLocale('en-GB')
+        .withPresetIssuingCountry('GBR')
+        .withSuccessUrl(`${config.YOTI_APP_BASE_URL}/success`)
+        .withErrorUrl(`${config.YOTI_APP_BASE_URL}/error`)
+        .withAllowHandoff(true)
+        .withIdDocumentTextExtractionGenericRetries(3)
+        .withIdDocumentTextExtractionReclassificationRetries(3)
+        .withSuppressedScreens([
+          'ID_DOCUMENT_EDUCATION',
+          'ID_DOCUMENT_REQUIREMENTS',
+        ])
+        .build()
+    )
+    .withRequiredDocument(
+      (new RequiredIdDocumentBuilder()).build()
+    )
+    .build();
+
+  return idvClient.createSession(sessionSpec);
+}
+
+module.exports = async (req, res) => {
+  try {
+    const session = await createSession();
+
+    req.session.IDV_SESSION_ID = session.getSessionId();
+    req.session.IDV_SESSION_TOKEN = session.getClientSessionToken();
+
+    res.render('pages/session', {
+      sessionId: req.session.IDV_SESSION_ID,
+      iframeUrl: `${config.YOTI_IDV_IFRAME_URL}?sessionID=${req.session.IDV_SESSION_ID}&sessionToken=${req.session.IDV_SESSION_TOKEN}`,
+    });
+  } catch (error) {
+    res.render('pages/error', { error });
+  }
+};

examples/idv/src/routes/use-cases-router.js

@@ -14,6 +14,7 @@ const {
   faceComparisonCheckController,
   faceMatchCheckController,
   watchlistCheckController,
+  suppressedScreensCheckController,
 } = controllers.useCasesControllers;
 
 const caseIdToControllerMapping = {
@@ -24,6 +25,7 @@ const caseIdToControllerMapping = {
   [Cases.FACE_COMPARISON]: faceComparisonCheckController,
   [Cases.FACE_MATCH]: faceMatchCheckController,
   [Cases.WATCHLIST]: watchlistCheckController,
+  [Cases.SUPPRESSED_SCREENS]: suppressedScreensCheckController,
 };
 
 const casesEntries = [...CasesMap.entries()];

examples/idv/src/useCases.js

@@ -6,6 +6,7 @@ const Cases = {
   FACE_COMPARISON: 'faceComparison',
   FACE_MATCH: 'faceMatch',
   WATCHLIST: 'watchlist',
+  SUPPRESSED_SCREENS: 'suppressedScreens',
 };
 
 const CasesMap = new Map([
@@ -37,6 +38,10 @@ const CasesMap = new Map([
     name: 'Watchlist check',
     path: '/watchlist-check',
   }],
+  [Cases.SUPPRESSED_SCREENS, {
+    name: 'Suppressed screens check',
+    path: '/suppressed-screens-check',
+  }],
 ]);
 
 module.exports = {

src/idv_service/session/create/sdk.config.builder.js

@@ -264,6 +264,20 @@ class SdkConfigBuilder {
     return this;
   }
 
+  /**
+   * Sets the suppressed screens on the builder
+   *
+   * @param {string[]} screens
+   *
+   * @returns {this}
+   */
+  withSuppressedScreens(screens) {
+    Validation.notNullOrEmpty(screens, 'suppressedScreens');
+    Validation.isArrayOfStrings(screens, 'suppressedScreens');
+    this.suppressedScreens = screens;
+    return this;
+  }
+
   /**
    * Builds the {@link SdkConfig} using the values supplied to the builder
    *
@@ -283,7 +297,8 @@ class SdkConfigBuilder {
       this.biometricConsentFlow,
       this.allowHandoff,
       this.attemptsConfiguration,
-      this.brandId
+      this.brandId,
+      this.suppressedScreens
     );
   }
 }

src/idv_service/session/create/sdk.config.js

@@ -30,6 +30,8 @@ class SdkConfig {
    *   The attempts configuration
    * @param {string} brandId
    *   The brandID for the client
+   * @param {string[]} suppressedScreens
+   *   The list of suppressed screens
    */
   constructor(
     allowedCaptureMethods,
@@ -44,7 +46,8 @@ class SdkConfig {
     biometricConsentFlow,
     allowHandoff,
     attemptsConfiguration,
-    brandId
+    brandId,
+    suppressedScreens
   ) {
     Validation.isString(allowedCaptureMethods, 'allowedCaptureMethods', true);
     /** @private */
@@ -99,6 +102,13 @@ class SdkConfig {
     Validation.isString(brandId, 'brandId', true);
     /** @private */
     this.brandId = brandId;
+
+    if (suppressedScreens) {
+      Validation.notNullOrEmpty(suppressedScreens, 'suppressedScreens');
+      Validation.isArrayOfStrings(suppressedScreens, 'suppressedScreens');
+      /** @private */
+      this.suppressedScreens = suppressedScreens;
+    }
   }
 
   /**
@@ -119,6 +129,7 @@ class SdkConfig {
       allow_handoff: this.allowHandoff,
       attempts_configuration: this.attemptsConfiguration,
       brand_id: this.brandId,
+      suppressed_screens: this.suppressedScreens,
     };
   }
 }

tests/idv_service/session/create/sdk.config.builder.test.js

@@ -17,6 +17,7 @@ describe('SdkConfigBuilder', () => {
       .withBiometricConsentFlow('some-flow')
       .withAllowHandoff(true)
       .withBrandId('some-brand-identifier')
+      .withSuppressedScreens(['SCREEN_1', 'SCREEN_3'])
       .build();
 
     const expectedJson = JSON.stringify({
@@ -32,6 +33,7 @@ describe('SdkConfigBuilder', () => {
       biometric_consent_flow: 'some-flow',
       allow_handoff: true,
       brand_id: 'some-brand-identifier',
+      suppressed_screens: ['SCREEN_1', 'SCREEN_3'],
     });
 
     expect(JSON.stringify(sdkConfig)).toBe(expectedJson);

types/src/idv_service/session/create/sdk.config.builder.d.ts

@@ -172,6 +172,15 @@ declare class SdkConfigBuilder {
      */
     withBrandId(brandId: string): this;
     brandId: string;
+    /**
+     * Sets the suppressed screens on the builder
+     *
+     * @param {string[]} screens
+     *
+     * @returns {this}
+     */
+    withSuppressedScreens(screens: string[]): this;
+    suppressedScreens: string[];
     /**
      * Builds the {@link SdkConfig} using the values supplied to the builder
      *

types/src/idv_service/session/create/sdk.config.d.ts

@@ -27,8 +27,10 @@ declare class SdkConfig {
      *   The attempts configuration
      * @param {string} brandId
      *   The brandID for the client
+     * @param {string[]} suppressedScreens
+     *   The list of suppressed screens
      */
-    constructor(allowedCaptureMethods: string, primaryColour: string, secondaryColour: string, fontColour: string, locale: string, presetIssuingCountry: string, successUrl: string, errorUrl: string, privacyPolicyUrl: string, biometricConsentFlow: string, allowHandoff: boolean, attemptsConfiguration: object, brandId: string);
+    constructor(allowedCaptureMethods: string, primaryColour: string, secondaryColour: string, fontColour: string, locale: string, presetIssuingCountry: string, successUrl: string, errorUrl: string, privacyPolicyUrl: string, biometricConsentFlow: string, allowHandoff: boolean, attemptsConfiguration: object, brandId: string, suppressedScreens: string[]);
     /** @private */
     private allowedCaptureMethods;
     /** @private */
@@ -55,6 +57,8 @@ declare class SdkConfig {
     private attemptsConfiguration;
     /** @private */
     private brandId;
+    /** @private */
+    private suppressedScreens;
     /**
      * Returns serialized data for JSON.stringify()
      */
@@ -72,5 +76,6 @@ declare class SdkConfig {
         allow_handoff: boolean;
         attempts_configuration: any;
         brand_id: string;
+        suppressed_screens: string[];
     };
 }

types/src/idv_service/session/retrieve/breakdown.response.d.ts

@@ -18,9 +18,9 @@ declare class BreakdownResponse {
      */
     getResult(): string;
     /**
-     * @returns {string} Likely 'AUTOMATED' or 'EXPERT_REVIEW'
+     * @returns {string|undefined} Likely 'AUTOMATED' or 'EXPERT_REVIEW'
      */
-    getProcess(): string;
+    getProcess(): string | undefined;
     /**
      * @returns {DetailsResponse[]}
      */