Release 14.40.0

onfido · Dec 12, 2024 · 513f8de · 513f8de
1 parent 7083b2e
commit 513f8de
Show file tree

Hide file tree

Showing 47 changed files with 274 additions and 171 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
-## 14.39.2 - 2024-11-25
+## 14.40.0 - 2024-12-11
+### Added
+- Add workflow task id in document module inputs
+
+### Fixed
+- Do not show the consent screen if consent was already granted
 
 ## 14.39.1 - 2024-11-20
 

diff --git a/README.md b/README.md
@@ -233,7 +233,7 @@ To customize the SDK, you can pass the required values to the `theme` object, in
 
 - **`name {Object}` - required**
 
-  The theme's `name` object allows for **dark mode** customization by setting the value to `light` or `dark`. 
+  The theme's `name` object allows for **dark mode** customization by setting the value to `light` or `dark`.
 
 - **`config {Object}` - optional**
 
@@ -1196,28 +1196,6 @@ The callbacks return a `FormData` object, including the information that the SDK
 }
 ```
 
-### Custom biometric token storage
-
-When using the decentralized authentication solution, by default the SDK manages biometric token storage, by storing it on local storage. The SDK also allows the clients to take control of the token lifecycle and exposes an callback to override the default implementation to read and write the token, so it can be stored on device, in cloud, in a keystore or on your premises.
-
-**Note** that by using the callback it will prevent the SDK to store the token.
-
-```typescript
-Onfido.init({
-	...
-  onBiometricTokenGenerated: (customerUserHash: string, biometricToken: string): void => {
-    // Called when new biometric token is generated during onboarding
-    // Use this callback to securely store the biometric token
-    // Please ensure that customerUserHash to biometricToken relationship is 1:1
-  },
-  onBiometricTokenRequested: (customerUserHash: string): Promise<string> => {
-    // Called when biometric token is requested during re-authentication
-    // Once you have the token, resolve the promise with it
-    return Promise.resolve('biometricToken')
-  }
-});
-```
-
 #### Uploading the media files to Onfido
 
 By default, this feature will prevent the request from being sent to Onfido, requiring you to [manually upload](https://documentation.onfido.com/api/latest#upload-document) the media files to Onfido from your backend for further processing.
@@ -1472,14 +1450,13 @@ A prerequisite is that you host the cross-device experience of the Onfido SDK yo
 
 ##### Enable custom media callbacks in mobile session
 
-Once you have a server with the Onfido Web SDK installed and set up, you must initialize the mobile session with `mobileFlow: true` in addition to the callbacks and `useCustomizedApiRequests` options shown above.
+Once you have a server with the Onfido Web SDK installed and set up, you must initialize the mobile session with the callbacks and `useCustomizedApiRequests` options shown above.
 
 ```javascript
 Onfido.init({
   ...
   enterpriseFeatures: {
     useCustomizedApiRequests: true,
-    mobileFlow: true,
     onSubmitDocument: (documentData) => {
       // Your callback code here
     },
@@ -1498,6 +1475,28 @@ Onfido.init({
 Media callbacks can also be triggered in the desktop session instead of the mobile session.
 To do so, please contact your Onfido Solution Engineer or Customer Success Manager as additional configuration is required.
 
+### Custom biometric token storage
+
+When using the decentralized authentication solution, by default the SDK manages biometric token storage, by storing it on local storage. The SDK also allows the clients to take control of the token lifecycle and exposes an callback to override the default implementation to read and write the token, so it can be stored on device, in cloud, in a keystore or on your premises.
+
+**Note** that by using the callback it will prevent the SDK to store the token.
+
+```typescript
+Onfido.init({
+	...
+  onBiometricTokenGenerated: (customerUserHash: string, biometricToken: string): void => {
+    // Called when new biometric token is generated during onboarding
+    // Use this callback to securely store the biometric token
+    // Please ensure that customerUserHash to biometricToken relationship is 1:1
+  },
+  onBiometricTokenRequested: (customerUserHash: string): Promise<string> => {
+    // Called when biometric token is requested during re-authentication
+    // Once you have the token, resolve the promise with it
+    return Promise.resolve('biometricToken')
+  }
+});
+```
+
 ### User analytics callbacks
 
 The SDK allows you to track a user's journey through the verification process via a dispatched event. This gives insight into how your users make use of the SDK screens.
@@ -1611,49 +1610,9 @@ COPY ./nginx.conf /etc/nginx/conf.d/default.conf
 
 ### Set up a server to host the Onfido Web SDK yourself at the provided URL
 
-This server must use the same version of the Onfido Web SDK and must initialize the SDK with `Onfido.init({ mobileFlow: true })`. All other configuration options, except for callbacks provided for the `useCustomizedApiRequests` feature, will be provided by your original instance of the Onfido Web SDK.
-
-This is an example of how you could host the Onfido Web SDK with minimal setup. This example involves using docker and an nginx image to serve an html file which starts the Onfido Web SDK using just the js and css files from the Onfido CDN (`https://sdk.onfido.com/<version>`).
-
-File structure for this minimal example:
-
-```text
-- dockerfile
-- nginx.conf
-- index.html
-```
-
-dockerfile
-
-```docker
-FROM nginx:1.15.8-alpine
-
-COPY ./nginx.conf /etc/nginx/conf.d/default.conf
-
-COPY ./index.html /usr/share/nginx/html/
-
-COPY ./dist /usr/share/nginx/sdk/
-
-```
-
-nginx.conf
-
-```nginx
-server {
-  # Change the next 2 lines as needed
-  listen       80;
-  server_name  localhost;
+This server must use the same version of the Onfido Web SDK and must initialize the SDK with `Onfido.init({ roomId: "<INSERT ROOM ID HERE>" })`. All other configuration options, except for callbacks provided for the `useCustomizedApiRequests` feature, will be provided by your original instance of the Onfido Web SDK.
 
-  location ~ ^/[0-9a-zA-Z]+$ {
-    root   /usr/share/nginx/html;
-    try_files $uri /index.html =404;
-  }
-
-  location ~* \.(js|jpg|png|css)$ {
-    root /usr/share/nginx/sdk/;
-  }
-}
-```
+Below is an example of how you could host the Onfido Web SDK with minimal setup. This `index.html` file starts the Onfido Web SDK using only the `js` and `css` files from the Onfido CDN (`https://sdk.onfido.com/<version>`).
 
 index.html
 
@@ -1686,28 +1645,32 @@ index.html
           top: 10%;
         }
         .onfido-sdk-ui-Modal-inner {
-          font-family: 'Open Sans', sans-serif !important;
+          font-family: "Open Sans", sans-serif !important;
         }
       }
     </style>
-    <script type="text/javascript">
-      // commonjs style require
-      var Onfido = require('onfido-sdk-ui')
-
-      var version = window.location.pathname.substring(1, 3)
-
-      var script = document.createElement('script')
-      script.onload = function () {
-        window.onfidoOut = Onfido.init({ mobileFlow: true })
-      }
-      document.head.appendChild(script)
-    </script>
+    <!-- Important: You must use the same version as you are using on the desktop -->
+    <script src="https://sdk.onfido.com/v14" charset="utf-8"></script>
   </head>
 
   <body>
     <div id="onfido-mount"></div>
+    <script type="text/javascript">
+      /*
+        Get the roomId from the url (last 6 characters)
+        Example:
+        - https://example.com/XXCOXCKL -> roomId (COXCKL)
+      */
+      var roomId = window.location.pathname.substring(3, 9);
+
+      Onfido.init({
+        containerId: "onfido-mount",
+        roomId,
+      });
+    </script>
   </body>
 </html>
+
 ```
 
 ## More information

diff --git a/locales/ar/ar.json b/locales/ar/ar.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "حدد بنكًا من القائمة أدناه للتحقق من نفسك من خلاله",
-                "title": "التحقق"
+                "subtitle": "اختر بنكًا من القائمة أدناه للتحقق من هويتك عبر <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "هوية Onfido الحقيقية"
             },
+            "icon_error_accessibility": "خطأ:",
             "icon_info_accessibility": "معلومات:",
+            "icon_success_accessibility": "نجاح:",
+            "icon_warning_accessibility": "تحذير:",
             "lazy_load_placeholder": "جارٍ التحميل...",
             "loading": "جارٍ التحميل"
         },

diff --git a/locales/bg/bg.json b/locales/bg/bg.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Изберете банка от списъка по-долу, за да се удостоверите чрез нея",
-                "title": "Проверка"
+                "subtitle": "Изберете банка от списъка по-долу, за да се верифицирате чрез <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido истинска идентичност"
             },
+            "icon_error_accessibility": "Грешка:",
             "icon_info_accessibility": "Информация:",
+            "icon_success_accessibility": "Успех:",
+            "icon_warning_accessibility": "Предупреждение:",
             "lazy_load_placeholder": "Зареждане...",
             "loading": "Зареждане"
         },

diff --git a/locales/cs/cs.json b/locales/cs/cs.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Vyberte banku ze seznamu níže pro ověření své identity",
-                "title": "Ověření"
+                "subtitle": "Vyberte banku ze seznamu níže pro ověření vaší identity prostřednictvím <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido skutečná identita"
             },
+            "icon_error_accessibility": "Chyba:",
             "icon_info_accessibility": "Informace:",
+            "icon_success_accessibility": "Úspěch:",
+            "icon_warning_accessibility": "Varování:",
             "lazy_load_placeholder": "Nahrávání...",
             "loading": "Načítání"
         },

diff --git a/locales/da/da.json b/locales/da/da.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Vælg en bank fra listen nedenfor for at verificere dig selv igennem",
-                "title": "Verificering"
+                "subtitle": "Vælg en bank fra listen nedenfor for at verificere dig selv gennem <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido ægte identitet"
             },
+            "icon_error_accessibility": "Fejl:",
             "icon_info_accessibility": "Information:",
+            "icon_success_accessibility": "Succes:",
+            "icon_warning_accessibility": "Advarsel:",
             "lazy_load_placeholder": "Indlæser...",
             "loading": "Indlæser"
         },

diff --git a/locales/de/de.json b/locales/de/de.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Wählen Sie eine Bank aus der untenstehenden Liste aus, um sich darüber zu verifizieren",
-                "title": "Überprüfung"
+                "subtitle": "Wählen Sie eine Bank aus der Liste unten aus, um sich über <form_scheme><\/form_scheme> zu verifizieren.",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido echte Identität"
             },
+            "icon_error_accessibility": "Fehler:",
             "icon_info_accessibility": "Information:",
+            "icon_success_accessibility": "Erfolg:",
+            "icon_warning_accessibility": "Warnung:",
             "lazy_load_placeholder": "Wird geladen…",
             "loading": "Wird geladen"
         },

diff --git a/locales/el/el.json b/locales/el/el.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Επιλέξτε μια τράπεζα από την παρακάτω λίστα για να επαληθεύσετε τον εαυτό σας μέσω αυτής",
-                "title": "Επαλήθευση"
+                "subtitle": "Επιλέξτε μια τράπεζα από τη λίστα παρακάτω για να επαληθεύσετε τον εαυτό σας μέσω <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Πραγματική ταυτότητα Onfido"
             },
+            "icon_error_accessibility": "Σφάλμα:",
             "icon_info_accessibility": "Πληροφορίες:",
+            "icon_success_accessibility": "Επιτυχία:",
+            "icon_warning_accessibility": "Προειδοποίηση:",
             "lazy_load_placeholder": "Φόρτωση...",
             "loading": "Φόρτωση"
         },

diff --git a/locales/en_GB/en_GB.json b/locales/en_GB/en_GB.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Select a bank from the list below to verify yourself through",
-                "title": "Verification"
+                "subtitle": "Select a bank from the list below to verify yourself through <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido real identity"
             },
+            "icon_error_accessibility": "Error:",
             "icon_info_accessibility": "Information:",
+            "icon_success_accessibility": "Success:",
+            "icon_warning_accessibility": "Warning:",
             "lazy_load_placeholder": "Loading...",
             "loading": "Loading"
         },

diff --git a/locales/en_US/en_US.json b/locales/en_US/en_US.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Select a bank from the list below to verify yourself through",
-                "title": "Verification"
+                "subtitle": "Select a bank from the list below to verify yourself through <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido real identity"
             },
+            "icon_error_accessibility": "Error:",
             "icon_info_accessibility": "Information:",
+            "icon_success_accessibility": "Success:",
+            "icon_warning_accessibility": "Warning:",
             "lazy_load_placeholder": "Loading...",
             "loading": "Loading"
         },

diff --git a/locales/es/es.json b/locales/es/es.json
@@ -358,8 +358,8 @@
         },
         "eid": {
             "scheme_form": {
-                "subtitle": "Selecciona un banco de la lista a continuación para verificarte a través de él",
-                "title": "Verificación"
+                "subtitle": "Seleccione un banco de la lista a continuación para verificarse a través de <form_scheme><\/form_scheme>",
+                "title": "<form_scheme><\/form_scheme> Verification"
             }
         },
         "error_unsupported_browser": {
@@ -463,7 +463,10 @@
             "footer": {
                 "branding": "Onfido identidad real"
             },
+            "icon_error_accessibility": "Error:",
             "icon_info_accessibility": "Información:",
+            "icon_success_accessibility": "Éxito:",
+            "icon_warning_accessibility": "Advertencia:",
             "lazy_load_placeholder": "Cargando...",
             "loading": "Cargando"
         },