gbc-kyc-kit 1.2.6 → 1.3.6

package/README.md

@@ -98,6 +98,7 @@ If you use this components with TypeScript, you should create a customType.d.ts
 | clientId     | string  | Global Bridge Connections send you for email | This value is unique for each client and will be sent for email.                                                                                                                            |
 | authorize    | promise | () => Promise()                              | This Function verify clientId vs TOKEN and return accessToken.                                                                                                                              |
 | dual         | boolean | false                                        | Isn't required and the default value is false. Just would used to enable dual upload of ID Document in Document Reader component (Two sides)                                                |
+| picBase64    | string  |                                              | Is required. It would be used to compare the selfie image with this picture                                                                                                                 |
 
 ## Document Reader Component
 
@@ -108,7 +109,9 @@ import { DocumentReader } from "gbc-kyc-kit";
 Props Available:
 
 - mode: string 'dark' || 'light' default is 'light'
-- loader: bool default is false
+- dual: bool default is false
+- inProduction: string default is prd
+- dataDocument: function to get response
 
 ```js
 const getDataDocument = async (info) => {
@@ -135,7 +138,7 @@ import { LivenessCheck } from "gbc-kyc-kit";
 Props Available:
 
 - mode: string 'dark' || 'light' default is 'light'
-- loader: bool default is false
+- inProduction: string default is prd
 
 ```js
 const listener = (event) => {
@@ -168,6 +171,11 @@ useEffect(() => {
 import { BlackList } from "gbc-kyc-kit";
 ```
 
+Props Available:
+
+- mode: string 'dark' || 'light' default is 'light'
+- inProduction: string default is prd
+
 ```js
 <BlackList
   clientId={clientId}
@@ -176,3 +184,32 @@ import { BlackList } from "gbc-kyc-kit";
   mode="dark" // Default value is light, not is required
 />
 ```
+
+## Facematch Component
+
+```js
+import { FaceMatch } from "gbc-kyc-kit";
+```
+
+Props Available:
+
+- mode: string 'dark' || 'light' default is 'light'
+- inProduction: string default is prd
+- picBase64: string img to compare with selfie in base64 format
+- dataFaceMatch: function to get response
+
+```js
+const getDataFaceMatch = async (info) => {
+  if (info) {
+    console.log(info.data);
+  }
+};
+// This component return data and you can get it with getDataFaceMatch function.
+
+<FaceMatch
+  dataFaceMatch={getDataFaceMatch}
+  clientId={clientId}
+  authorize={getAccessToken}
+  inProduction="prd"
+/>;
+```