@ekyc_qoobiss/qbs-ect-cmp 1.6.5 → 1.7.1

package/README.md

@@ -17,10 +17,33 @@ The wev compoment has to be included in the html markup like this:
 \*.html
 
 ```sh
-<identification-component token="{{ token }}" order_id="{{ orderId }}"></identification-component>
+<identification-component token="{{ token }}" order_id="{{ orderId }}" api_url="{{ apiUrl }}"></identification-component>
 ```
 
-There are two parameters:
+### There are two parameters:
 
 - token - which is the token that was obtained using the API Key on the server side;
-- order_id - is a unique ID that will be used for the current identification request when obtaining the processed data from the REST API Service.
+- order_id - is a unique ID that will be used for the current identification request when obtaining the processed data from the REST API Service;
+- api_url - is the base api url that we have provided for you.
+
+### Obtaining the token
+
+To get the token you have to make a server-side GET request to this url: [apiUrl]/token
+The authentication is done using the API Key that you received from us.
+
+### The component will raise these events:
+
+- 'ect-started' - when the component was loaded and initialted
+- 'ect-error' - when a critical error has ocurred and the flow cannot continue
+- 'ect-session-expired' - when the token has expired
+- 'ect-completed' - when the flow has ended.
+
+### Obtaining the result
+
+To get the result of the collection process, you have to make a GET call to the endpoint [apiUrl]/validation/identity/result?orderId=[orderId]. The result will be a json with the details we have processesd. The result is encrypted using AES with a symmetrical key that you will be provided with. To be able to call the endpoint you have to use either a valid token or the API Key.
+If the request is not yet processes, the response will be a json of this type:
+{
+"OrderID": "the id",
+"Status": "[Incomplete|NotStarted|Running]"
+}
+When the processing has finished the response will return the encrypted data.

package/dist/cjs/agreement-check_16.cjs.entry.js

@@ -5263,7 +5263,7 @@ const IdBackCapture = class {
   }
   async componentWillLoad() {
     Events.init(this.component);
-    this.titleMesage = IdCaptureValues.Title;
+    this.titleMesage = IdCaptureValues.TitleBack;
     if (!navigator.mediaDevices) {
       Events.flowError('This browser does not support webRTC');
     }

package/dist/collection/components/common/id-back-capture/id-back-capture.js

@@ -40,7 +40,7 @@ export class IdBackCapture {
   }
   async componentWillLoad() {
     Events.init(this.component);
-    this.titleMesage = IdCaptureValues.Title;
+    this.titleMesage = IdCaptureValues.TitleBack;
     if (!navigator.mediaDevices) {
       Events.flowError('This browser does not support webRTC');
     }

package/dist/esm/agreement-check_16.entry.js

@@ -5259,7 +5259,7 @@ const IdBackCapture = class {
   }
   async componentWillLoad() {
     Events.init(this.component);
-    this.titleMesage = IdCaptureValues.Title;
+    this.titleMesage = IdCaptureValues.TitleBack;
     if (!navigator.mediaDevices) {
       Events.flowError('This browser does not support webRTC');
     }