Skip to content

iOS Framework for capturing documents and faces at a resolution appropriate for our proprietary Deep Learning OCR and Face Recognition Engines.

Notifications You must be signed in to change notification settings

hyperverge/HyperKYC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HyperKYC

HyperKyc SDK can be used to create Global DKYC workflows to capture images of ID cards, photos of the face of the user, and perform other operations like face matches, etc all within itself to ease up integration friction on the client end.

This SDK can be used within iOS native apps and supports all iOS versions from iOS 11

Minimum Requirements

  1. min iOS SDK version 11
  2. Recommended platform versions :
    1. xCode 15.1+
    2. Swift 5.5
    3. Cocoapods 1.11.x

Integration steps:

  1. Add HyperKyc SDK to your project and run pod install
pod 'HyperKYC'

Camera Permissions

To request the user for camera permissions, add this key-value pair in your application's info.plist file.

  • Key : Privacy - Camera Usage Description

  • Value : "Access to camera is needed for document and face capture"

  1. Import HyperKYC module
import HyperKYC
  1. Create HyperKycConfig instance
//  Create HyperKycConfig instance using appId-appKey (less secure)
let hyperKycConfig = HyperKycConfig(
                    appId: "<app-id>", // get this from Hyperverge team
                    appKey: "<app-key>", // get this from Hyperverge team
                    workflowId: "<workflow-id>", // get this from Hyperverge dashboard
                    transactionId: "<transaction-id>"
                )

OR

//  Create HyperKycConfig instance using accessToken (more secure)
let hyperKycConfig = HyperKycConfig(
                    accessToken: "<access-token>", // contact Hyperverge team to get more info about accessToken
                    workflowId: "<workflow-id>", // get this from Hyperverge dashboard
                    transactionId: "<transaction-id>"
                )
  1. Create completionHandler instance
let completionHandler :(_ hyperKycResult: HyperKycResult) -> Void = {
    hyperKycResult in
        //  Handle hyperKycResult (contact Hyperverge team for more info)
}
  1. Call HyperKYC.launch()
HyperKyc.launch(self, hyperKycConfig: hyperKycConfig, completionHandler)

Please contact Hyperverge for complete documentation and a properly designed solution specific to your usecase to use HyperKyc SDK to its optimum capacity

About

iOS Framework for capturing documents and faces at a resolution appropriate for our proprietary Deep Learning OCR and Face Recognition Engines.

Resources

Stars

Watchers

Forks

Packages

No packages published