Introduction

The eKYC module is an Fcloud service developed by Ftech. The module allows customer identity verification through the application of electronic technology. To integrate and use this service, you must use Fcloud's SDK. And here are instructions for integrating the SDK.

Authentication

To call the APIs, we will have to init the SDK with the parameters ClientID and SecretKey taken when you create the Application on CMS for partners according to the following instructions:

• Log in to CMS Partner with the username/password provided (https://fcloud-partner-cms.ftech.ai)
• Buy a service package
• Create App

Server Integrator

After integrating the SDK, the Fcloud service supports server-server callbacks to help get request information as quickly and accurately as possible.

Web SDK

Android SDK

Install SDK Android

Setup gradle maven

• With Gradle v1.x - v5.x Open build.grade file and add maven line like below

allprojects {
    repositories {
        google()  
        mavenCentral()
        maven { url 'https://jitpack.io' } <- // add this line
    }
}

• With Gradle v6.x+ Open setting.gradle file and add maven line like below

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } <- // add this line
    }
}

Open file app/build.grade then add sdk

dependencies {
...
   implementation "com.github.ftechmobile:feykc-android:1.0.1"
}

Init in file Application

override fun onCreate() {
        super.onCreate()
        ...
        FTechEkycManager.init(this)
    }

SDK Android Integration

Init

• After successful initial, the SDK returns a status resulting in the onSuccess() callback. Handling of successful initial here.
• When initial fails, it will be processed at callback onFail().

FTechEkycManager.registerEkyc(appId, licenseKey, new IFTechEkycCallback<Boolean>() {
            @Override
            public void onSuccess(Boolean info) {

            }

            @Override
            public void onFail(APIException error) {

            }

            @Override
            public void onCancel() {

            }
        });

Register callback

Calling functions in activity lifecycle

    @Override
    protected void onResume() {
        super.onResume();
        FTechEkycManager.notifyActive(this);
    }

    @Override
    protected void onPause() {
        super.onPause();
        FTechEkycManager.notifyInactive(this);
    }

SDK Android Feature

Create transaction

• Used to create transaction for Ekyc execution session
• When successful transaction creation, the SDK returns a model transaction data which leads to the onSuccess() callback
• When creating transaction fails, it will be processed at callback onFail()

FTechEkycManager.createTransaction(new IFTechEkycCallback<TransactionData>() {
            @Override
            public void onSuccess(TransactionData info) {

            }

            @Override
            public void onFail(APIException error) {

            }

            @Override
            public void onCancel() {

            }
        });

Get process transaction

• Used to get the Ekyc process of a transaction
• When the get process transaction is successful, the SDK returns a model process transaction data resulting in the onSuccess() callback
• When get process transaction fails, it will be processed at callback onFail()

FTechEkycManager.getProcessTransaction(transactionId, new IFTechEkycCallback<TransactionProcessData>() {
            @Override
            public void onSuccess(TransactionProcessData info) {

            }

            @Override
            public void onFail(APIException error) {

            }

            @Override
            public void onCancel() {

            }
        });

Upload Photo (Normal detection)

• Used to upload photos of documents, face for Ekyc
• When the photo upload is successful, the SDK returns a model capture data resulting in the onSuccess() callback
• When uploading photo fails, it will be handled at callback onFail()

FTechEkycManager.uploadPhoto(pathImage, captureType, new IFTechEkycCallback<CaptureData>() {
            @Override
            public void onSuccess(CaptureData info) {

            }

            @Override
            public void onFail(APIException error) {

            }

            @Override
            public void onCancel() {

            }
        });

Face Matching

Use this method to get ORC scan information

• Use this method to get ORC scan information
• When face matching is successful, the SDK returns a model face matching data resulting in the onSuccess() callback
• When face matching fails, it will be handled at the callback onFail()

FTechEkycManager.faceMatching(new IFTechEkycCallback<FaceMatchingData>() {
           @Override
           public void onSuccess(FaceMatchingData info) {
           }

           @Override
           public void onFail(APIException error) {
           }

           @Override
           public void onCancel() {
           }
       })

FaceMatchingData

CardInfo

Liveness detection

Using bitmap image to check face position

• For enable/disable liveness detection, use this:

FTechEkycManager.setEnableLiveness(true);

FTechEkycManager.detectFacePose(bitmap, FACE_POSE.UP, new IFTechEkycCallback<Boolean>() {
            @Override
            public void onSuccess(Boolean info) {

            }

            @Override
            public void onFail(APIException error) {

            }

            @Override
            public void onCancel() {

            }
        });

Submit info

Use this method to submit information

• After submitting the info successfully, the SDK returns a status leading to the onSuccess() callback
• When submitting information fails, it will be handled at the callback onFail()

FTechEkycManager.submitInfo(submitInfoRequest, new IFTechEkycCallback<Boolean>() {
           @Override
           public void onSuccess(Boolean info) {
           }

           @Override
           public void onFail(APIException error) {
           }

           @Override
           public void onCancel() {
           }
       });

NewSubmitInfoRequest

CardInfoSubmit

IOS SDK

Install SDK IOS

Add package dependencies

https://github.com/FTechMobile/fekyc

SDK IOS Integration

Register callback

    FEKYCApp.instance().delegate = self

And implement FEKYCDelegate

Init

• Upon successful registration, the SDK returns a status resulting in the registerEkycSuccess() callback. Handling of successful registration here.
• When register fails, it will be processed at callback ekycFailure(). swift FEKYCApp.instance().registerEkyc(licenseKey, appID)

SDK IOS Feature

Enable Liveness version

    FEKYCApp.setEnableLiveness()

Use full stream sdk

    FEKYCApp.instance().start()

Note: If you don't want to use enough threads, the SDK provides the following features

Create transaction

• Used to create transaction for Ekyc execution session
• When successful transaction creation, the SDK returns a model transaction data which leads to the creatTransactionSuccess() callback. Handling create transaction successfully here.
• When creating transaction fails, it will be processed at callback ekycFailure().

    FEKYCApp.instance().createTransaction()

Get process transaction

• Used to get the Ekyc process of a transaction

    FEKYCApp.instance().getProcessTransaction(transactionId)

Upload Photo

• Used to upload photos of documents, face for Ekyc

• When the photo upload is successful, the SDK returns a model capture data resulting in the uploadPhotoSuccess() callback. Handling photo upload successfully here.
• When uploading photo fails, it will be handled at callback ekycFailure(). swift FEKYCApp.instance().uploadPhoto(step: FEKYCStep, imageFile: imageFile)

Face Matching

• Use this method to get ORC scan information & check matching face from upload photo
• When face matching is successful, the SDK returns a model face matching data resulting in the faceMatchingSuccess() callback. Handling face matching successfully here.

     FEKYCApp.instance().faceMatching()

FaceMatchingData

CardInfo

Submit info

• Use this method to submit information & finish ekyc session
• After submitting the info successfully, the SDK returns a status leading to the didEkycSuccess() callback. Handling submit info successfully here.

    FEKYCApp.instance().submitInfo(info: FaceMatchingData)

Errors

The Kittn API uses the following error codes: