IOS SDK Migration

Amani Core SDK Initialization

Core SDK V2

class AmaniInitializaion: UIViewController {
    let amani = Amani.sharedInstance
    
    override func viewDidLoad() {
        super.viewDidLoad()
      
        amani.initAmani(
                server: "ServerURL", 
                token: "Token", 
                customer: CustomerRequestModel.init(idCardNumber: "55555"))
                [weak self] { customerModel, error in
            print("\(customerModel), \(error)")
        }
    }
}

---

NOTE

Amani Delegate is available for use starting from Amani SDK v3.0.0 and later.

In versions below v3.0.0, delegate such as status returned as a result of document upload could be listened to once by the callback in the upload method of the relevant module. Amani Delegate replaces this structure and offers the opportunity to listen to delegate coming from the web socket in more detail.

---

Core SDK V3

class AmaniInitializaion: UIViewController {
  let amani = Amani.sharedInstance

override func viewDidLoad() {
    super.viewDidLoad()

    amani.setDelegate(delegate: self)
    amani.initAmani(
        server: "serverURL",
        token: "token", 
        apiVersion: .v1 //You must choose compatible with your server version.
        ) 
        { [weak self] (customerModel, error) in
        print("\(customerModel), \(error)")
     }
    }
}

Amani Delegate

//MARK: We are setting AmaniDelegate to ViewController
//MARK: You can handle here result of AmaniSDK responses.

extension AmaniInitializaion:AmaniDelegate{
  func onError(type: String, error: [AmaniSDK.AmaniError]) {
    print(type)
    print(error)
  }

  func onProfileStatus(customerId: String, profile: AmaniSDK.wsProfileStatusModel) {
    print(profile)
  }

  func onStepModel(customerId: String, rules: [AmaniSDK.KYCRuleModel]?) {
    print(rules)
  }
}

ID Module

Core SDK V2

class IDcaptureModule: UIViewController {
    
    let amaniIDCapture = Amani.sharedInstance.IdCapture()
    var idCaptureView: UIView? = UIView()
    
    override func viewDidLoad() {
           super.viewDidLoad()

        amaniIDCapture.setType(type: "XXX_ID_0")

           do {
               self.idCaptureView = try amaniIDCapture.start(stepId: steps.front.rawValue) { previewImage in
                   print(previewImage)
               }
               
               DispatchQueue.main.async {
                   self.view.addSubview(self.idCaptureView!)
               }
               
               DispatchQueue.main.async {
                   self.idCaptureView!.removeFromSuperview()
               }
               

               amaniIDCapture.upload(location: nil) { uploadSuccess, error in
                   print(uploadSuccess, error)
               }
              
           }catch {
               print(error)
           }
       }
}

Core SDK V3

For upload there is result, returning the file upload.

class IDcaptureModule: UIViewController {
    let amaniIDCapture = Amani.sharedInstance.IdCapture()
    var idCaptureView: UIView? = UIView()

    override func viewDidLoad() {
        super.viewDidLoad()
      do {
        let idcapture = amani.IdCapture()
        
        idcapture.setType(type: "XXX_ID_0") //Document types are not changed for server side. You can still use what you defined on your v2.

        self.idCaptureView = try idcapture.start(stepId: 0, completion: { [weak self] (previewView) in

            })
        // This func will return  to you a UIView. You can start the process using the UIView that appears.

        // ID Capture upload 
        amani.IdCapture().upload(location:  CLLocationManager().location) { result in
                print("return idupload :", result) 
            }
        }
    }
}

NFC Module with IDCapture

Core SDK V2

class IDcaptureModule: UIViewController {
    
    let amaniIDCapture = Amani.sharedInstance.IdCapture()
    var idCaptureView: UIView? = UIView()
    
    override func viewDidLoad() {
           super.viewDidLoad()

        amaniIDCapture.setType(type: "XXX_ID_0")
        //You should take front and back side of ID's. Than you can set startNFC function.
           do {
               self.idCaptureView = try amaniIDCapture.start(stepId: steps.front.rawValue) { previewImage in
                   print(previewImage)
               }
               
               DispatchQueue.main.async {
                   self.view.addSubview(self.idCaptureView!)
               }
               
               DispatchQueue.main.async {
                   self.idCaptureView!.removeFromSuperview()
               }

               amaniIDCapture.startNFC { isMrzRead in
                   print(isMrzRead)
               }

               amaniIDCapture.upload(location: nil) { uploadSuccess, error in
                   print(uploadSuccess, error)
               }
              
           }catch {
               print(error)
           }
       }
}

Core SDK V3

class IDCaptureWithNFC: UIViewController {
    var nviData:NviModel? {
    didSet{
      Task { @MainActor in
        if let nviData = nviData {
          let scannfc = await amaniScanNFC.startNFC(nvi: nviData)
        }
      }
    }
  }

  override func viewDidLoad() {
    super.viewDidLoad()
    
    let amaniScanNFC = Amani.sharedInstance.scanNfc()

    amaniScanNFC.setType(type: "XXX_ID_0")

    let nviData = NviModel(documentNo: "DOCUMENT NO IN ALL CAPS", dateOfBirth: "YYMMDD", dateOfExpire: "YYMMDD")

    do {
        let scannfc = try await amaniScanNFC.start(nvi: nviData)
    } catch (let error ) { 
        print(error)
    }

    ////////////////////////////////////

    var stepId = steps.front.rawValue //For ID's which has MRZ Field at the front side (like passport)
    let type = "XXX_ID_0"

    if((type.contains("ID"))){
      stepId = steps.back.rawValue ////For ID's which has MRZ Field at the back side (like ID Cards)
    }

    guard let idcaptureVC:UIView = try idcapture.start(stepId: stepId, completion: { [weak self] (previewImage) in

    amani.IdCapture().getMrz { [weak self] mrzDocumentId in
            self?.mrzDocumentId = mrzDocumentId
            }
    })
  }  
}

extension ViewController: mrzInfoDelegate {
   func mrzInfo(_ mrz: AmaniSDK.MrzModel?, documentId: String?) {
     guard let mrz = mrz else  {return}

     switch apiVersion {
     case .v1:
      let nviData = NviModel(mrzModel: mrz)
      self.nviData = nviData
     case .v2:
      if documentId == mrzDocumentId {
        let nviData = NviModel(mrzModel: mrz)
        self.nviData = nviData
      }
    default:
      break
    }
  }
}

Selfie Module

Core SDK V2

class SelfieModule: UIViewController {
    let amaniSelfie = Amani.sharedInstance.selfie()
    var selfieView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
      
        
        do {
            amaniSelfie.setType(type: "XXX_SE_0")
            self.selfieView = try amaniSelfie.start(completion: { previewImage in
                print(previewImage)
            })
           
            DispatchQueue.main.async {
                self.view.addSubview(self.selfieView!)
            }
            
            DispatchQueue.main.async {
                self.selfieView!.removeFromSuperview()
            }
            
            amaniSelfie.upload(location: nil) { uploadSuccess, error in
                print(uploadSuccess, error)
            }
        }catch {
            print(error)
        }
    }
}

Core SDK V3

class SelfieModule: UIViewController {
    let amaniSelfie = Amani.sharedInstance.selfie()
    var selfieView: UIView? = UIView()

    override func viewDidLoad() {
        super.viewDidLoad()
        do {  
            let selfie = amani.selfie()
            selfie.setType("XXX_SE_0")
            // selfie.setVideoRecording(enabled: Bool) ///// If you wish you can enable video recording when user taking selfie.

            self.selfieView = try selfie.start( completion: { [weak self] (previewImage) in

            })
            // This func will return to you a UIView. You can start the process using the UIView that appears.


            //Selfie Upload
            selfie.selfie().upload { isSuccess in
                print("selfie upload \(isSuccess)")
            } 
         }
        }

    }

Auto Selfie Module

Core SDK V2

class AutoSelfieModule: UIViewController {
    let amaniAutoSelfie = Amani.sharedInstance.autoSelfie()
    var autoSelfieView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        amaniAutoSelfie.setType(type: "XXX_SE_0")
        do {
            self.autoSelfieView = try amaniAutoSelfie.start { previewImage in
                print(previewImage)
            }
            
            amaniAutoSelfie.upload(location: nil) { uploadSuccess, error in
                print(uploadSuccess, error)
            }
        }catch {
            print(error)
        }

    }
}

Core SDK V3

class AutoSelfieModule: UIViewController {
    let amaniAutoSelfie = Amani.sharedInstance.autoSelfie()
    var autoSelfieView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        amaniAutoSelfie.setType(type: "XXX_SE_0")
        self.autoSelfieView = amaniAutoSelfie.start() {[weak self] previewImage in
            // after the process ends you can safely remove the autoSelfieView from your view controller
            DispatchQueue.main.async {
            self?.autoSelfieView.removeFromSuperView()
            }

            // TODO: upload or show a confirm screen
            }

            // don't forget to add the auto selfie view to your view controller
            DispatchQueue.main.async {
            self.view.addSubView(self.autoSelfieView)

            }

           amaniAutoSelfie.upload(location: nil) {[weak self] uploadSuccess in
                if (uploadSuccess != nil) {
                // uploadSuccess is a boolean variable
                // TODO: handle the upload state
                }
            } 
        }catch {
            print(error)
        }

}

Manuel Selfie Module

Core SDK V2

class ManuelSelfieModule: UIViewController {
    let manuelSelfie = Amani.sharedInstance.Selfie()
    var manuelSelfieView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        manuelSelfie.setType(type: "XXX_SE_0")
        do {
            self.manuelSelfieView = try manuelSelfie.start { previewImage in
                print(previewImage)
            }
            
            manuelSelfie.upload(location: nil) { uploadSuccess, error in
                print(uploadSuccess, error)
            }
        }catch {
            print(error)
        }
    }
}

Core SDK V3

class ManuelSelfieModule: UIViewController {
    let manuelSelfie = Amani.sharedInstance.Selfie()
    var manuelSelfieView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        manuelSelfie.setType(type: "XXX_SE_0")
        do {
           self.manuelSelfieView = amaniSelfie.start() {[weak self] previewImage in
            // after the process ends you can safely remove the selfieView from your view controller
            DispatchQueue.main.async {
                self.manuelSelfieView.removeFromSuperview()
            }

            // TODO: upload or show a confirm screen
            }

            // don't forget to add the selfie view to your view controller
            DispatchQueue.main.async {
            self.view.addSubview(self.manuelSelfieView)
            }
        }catch {
            print(error)
        }

        amaniSelfie.upload(location: nil) {[weak self] uploadSuccess in
            if (uploadSuccess != nil) {
                // uploadSuccess is a boolean variable
                // TODO: handle the upload state
            } 
         }
    }
}

PoseEstimation Module

Core SDK V2

class PoseEstimationModule: UIViewController {
    let amaniPoseEstimation = Amani.sharedInstance.poseEstimation()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        do {
            amaniPoseEstimation.setType(type: "XXX_SE_0")
            
            guard let view: UIView = try amaniPoseEstimation.start(stepId: 0, completion: { previewImage in
                print(previewImage)
            })else {
                return
            }
            amaniPoseEstimation.upload(location: nil) { uploadSuccess, error in
                print(uploadSuccess, error)
            }
        } catch {
            print(error)
        }
    }
}

Core SDK V3

class PoseEstimationModule: UIViewController {
    @IBAction func performPoseEstimation(_ sender: Any) {
    do {  
         let poseEstimation = amani.poseEstimation()
         poseEstimation.setType("XXX_SE_0")
         // selfie.setVideoRecording(enabled: Bool) ///// If you wish you can enable video recording when user taking selfie.
        
         poseEstimation.setInfoMessages(infoMessages: [
        .faceIsOk: "",
        .notInArea: "",
        .faceTooSmall: "",
        .faceTooBig: "",
        .turnRight: "",
        .turnLeft: "",
        .turnUp: "",
        .turnDown: "",
        .lookStraight: "",
        .errorMessage : "",
        .tryAgain : "",
        .errorTitle : "",
        .next: "",
        .holdPhoneVertically: "",
        .wrongPose: "",
        .closedEyes: "",
        .captureDescription: ""
      ])
      .setScreenConfig(screenConfig:  [
        .appBackgroundColor: "",
        .appFontColor: "",
        .primaryButtonBackgroundColor: "",
        .primaryButtonTextColor: "",
        .ovalBorderSuccessColor: "",
        .ovalBorderColor: "",
        .poseCount: "",
        .secondaryGuideVisibility: "",
        .buttonRadius: "",
      ])

         guard let selfieVC:UIView = try selfie.start( completion: { [weak self](previewImage) in

         })
         // This func will return  to you a UIView. You can start the process using the UIView that appears.

         //Pose Estimation upload 

        poseEstimation.upload(location:  CLLocationManager().location) { result in
          print("return pose estimation :", result)
        }

      }
    }
}

NFC Module

Core SDK V2

class NFCModule: UIViewController {
    let amaniScanNFC = Amani.sharedInstance.scanNFC()
    
    override func viewDidLoad() {
        super.viewDidLoad()
      
        do {
            amaniScanNFC.setType(type: "XXX_NF_0")
            let nviData = NviModel(documentNo: "DOCUMENT NO IN ALL CAPS", dateOfBirth: "YYMMDD", dateOfExpire: "YYMMDD")
            
           try amaniScanNFC.start(nviData: nviData) { nfcRequest, error in
                print(nfcRequest, error)
            }
        } catch {
            
        }
    }
}

Core SDK V3

class  NFCModule: UIViewController {
    let amaniScanNFC = Amani.sharedInstance.scanNfc()

    amaniScanNFC.setType(type: "XXX_NF_0")

    let nviData = NviModel(documentNo: "DOCUMENT NO IN ALL CAPS", dateOfBirth: "YYMMDD", dateOfExpire: "YYMMDD")

    do {
        let scannfc = try await amaniScanNFC.start(nvi: nviData)
    } catch (let error ) { 
        print(error)
    }

  ///NFC Upload

    amaniScanNFC.upload(location: nil) {[weak self] uploadSuccess in
    if (uploadSuccess != nil) {
    // uploadSuccess is a boolean variable
    // TODO: handle the upload state
  } 
}

}

Signature Module

Core SDK V2

class SignatureModule: UIViewController {
    let signature = Amani.sharedInstance.signature()
    var signatureView: UIView? = UIView()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        do {
            self.signatureView = try signature.start(stepId: 2) { previewImage in
                print(previewImage)
            }
            signature.setViewArea(viewArea: view.bounds)
            signature.capture()
            signature.upload { uploadSuccess, error in
                print(uploadSuccess, error)
            }
        }catch {
            print(error)
        }
        
        DispatchQueue.main.async {
            self.signatureView!.removeFromSuperview()
        }
        
        DispatchQueue.main.async {
            self.view.addSubview(self.signatureView!)
        }
        
    }
    
    @IBAction func captureAct(_ sender: UIButton) {
        signature.capture()
    }
    
    @IBAction func clearAct(_ sender: UIButton) {
        signature.clear()
    }
        
}

Core SDK V3

class ViewController {
    let amaniSignature = Amani.sharedInstance.Signature()

        // setting the canvas frame
        // for example purposes we used the whole frame of the view controller
        // TODO: change this for a different view like a subview that needs to be drawable
        amaniSignature.setViewArea(viewArea: view.bounds)

        // setting the buttons
        @IBAction func clearAct(_ sender: UIButton) {
        amaniSignature.clear()
        }

        @IBAction func confirmAct(_ sender: UIButton) {
        amaniSignature.confirm()
        }

        // setting the callbacks
        amaniSignature.setOnConfirmPressedCallback {(image, currentSignatureNo) in
        // TODO: do something with image
        // TODO: do something with currentSignatureNo
        }

    override func viewDidLoad() {
        super.viewDidLoad()
        self.signatureView = amaniSignature.start(stepId: 2) {(previewImage) in
        // preview image is the lastly taken signature
        // TODO: show a preview screen uses previewImage

        // remove the view
        DispatchQueue.main.async {
            self.signatureView.removeFromSuperview()
        }
        }

        // add the view
        DispatchQueue.main.async {
        self.view.addSubview(signatureView)
        }
    }

    amaniScanNFC.upload(location: nil) {[weak self] uploadSuccess in
    if (uploadSuccess != nil) {
        // uploadSuccess is a boolean variable
        // TODO: handle the upload state
        } 
    }
}