viettel-ekyc-sdk v1.1.5

Announcements

• 🙏 If you have a question, please opening a new issue.

viettel-ekyc-sdk

Setup

This library is available on npm, install it with: npm i viettel-ekyc-sdk or yarn add viettel-ekyc-sdk.

Usage

1. Import viettel-ekyc-sdk:

import {configApi, ViettelEkycScreen} from "viettel-ekyc-sdk";

2. Create a <ViettelEkycSdk> component and nest its content inside of it:

const screen = () => {
  return (<ViettelEkycScreen
    type='ocrFront'
    enableCheckSanity={true}
    enableCheckTempering={true}
    enableAddFace={false}
    showResultScreen={true}
    enableAutoCaptureCard={true}
    enableAutoCaptureFace={false}
    initialCamera={initialCamera}
    faceLivenessConfiguration={faceConfiguration}
    getResult={(response) => {
      console.log(response.cardInfo)
      console.log(response.faceMatching)
    }}
  />)
}

A complete example

import React, {useEffect} from 'react';
import {configApi, ViettelEkycScreen} from 'viettel-ekyc-sdk';

const initialCamera = {
  flash: 'off',
  zoom: 1,
  autoFocus: 'on',
  ratio: '16:9',
  type: 'front',
  isRecording: false,
  canDetectFaces: true,
  canDetectText: true,
  canDetectBarcode: true,
};

const faceConfiguration = {
  yawAngle: 20,
  pitchAngle: 10,
  rollAngle: 0,
  smilingProbability: 0.5,
  requireList: ['smile'],
};

const token = ''
const clientCode = ''
const App = () => {
  useEffect(() => {
    configApi(token, clientCode).then(() => console.log('Config api done'));
  }, []);

  return (
    <ViettelEkycScreen
      type="ocrFront"
      enableCheckSanity={true}
      enableCheckTempering={true}
      enableAddFace={false}
      showResultScreen={true}
      enableAutoCaptureCard={true}
      enableAutoCaptureFace={false}
      initialCamera={initialCamera}
      faceLivenessConfiguration={faceConfiguration}
      getResult={response => {
        console.log(response.cardInfo);
        console.log(response.faceMatching);
      }}
    />
  );
};