Custom Flow EKYC-iOS

Compatibility & Lib Size

• This version is compatible with portrait orientation for all devices iOS 13+ and iPadOS 13+.
• This version can install on iOS 11 but it can't work and need to add version checking.

Library Lib will add around ~10MB to your application in thining mode (The real download size on App Store )

Remark:
NFC will be supported by iPhone only due to hardware limitations.

---

Liveness License

To make the LiveNess feature work, EkycSDK check the app License based on IOS Bundle ID, so please contact our support team to support the new bundle ID.

If POC, please use com.ekyc.sdk.* format as your test project Bundle ID

---

Current Version

Mac EKYC Core: 1.11.4

Releases Notes

---

SDK Integration

Using Pod

1. In your Podfile, add pod 'AppManEKYC', :git => 'https://{{provided github token}}@github.com/appman-agm/AppManEKYC.git', :tag => '{{version}}' then run pod install.

2. Example:

   platform :ios, '13.0'
   
   target 'TestEKYC-POD' do
     use_frameworks!
     pod 'AppManEKYC', :git => 'https://[e-mail]/appman-agm/AppManEKYC.git', :tag => '{{version}}'
   end
   

Configure Info Plist

• Camera:

• Location (to get user location for dip chip flow)

If we don't use DipChip flow, please refer to Turn off DipChip Flow but still need to add Location privacy to info.plist to pass the Apple Review process.

• Photo (to save QR code for dipchip flow) (optional):

• NFC (optional):

Info.plist XML scripts

XML

<dict>
    <key>NFCReaderUsageDescription</key>
    <string>This app uses NFC to scan passports</string>
    <key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
    <array>
        <string>A0000002471001</string>
        <string>A0000002472001</string>
        <string>00000000000000</string>
    </array>

    <key>NSPhotoLibraryUsageDescription</key>
    <string>This app requires this permission to save DipChip QRCode</string>
    <key>NSPhotoLibraryAddUsageDescription</key>
    <string>This app requires this permission to save DipChip QRCode</string>

    <key>NSLocationWhenInUseUsageDescription</key>
    <string>This app requires location for DipChip feature</string>

    <key>NSCameraUsageDescription</key>
    <string>Need Camera for OCR</string>
</dict>

.entitlements

XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>com.apple.developer.nfc.readersession.formats</key>
	<array>
		<string>TAG</string>
		<string>NDEF</string>
	</array>
</dict>
</plist>

---

Usage

Start Custom Flow with EKYC process

1. Add import MaCEKYC_FT to your swift file.

2. Set configuration for tenantConfigClientName, baseURL, tenantConfigURL, ekycURL, verificationID, livenessSuccessText and isThaiOnly (language):

   - Production environment

   Swift

    var ekycConfiguration = EKYCConfiguration()
    ekycConfiguration.tenantConfigClientName = "{{clientName}}"
    ekycConfiguration.baseURL = "https://mac-portal.mac.appmanteam.com/api/{{version}}/kyc"
    ekycConfiguration.tenantConfigURL = "https://mac-portal.mac.appmanteam.com/api/v1/tenant-config"
    ekycConfiguration.ekycURL =  "https://{{clientName}}.mac.appmanteam.com/apps/identity-verification"
    ekycConfiguration.livenessSuccessText = LivenessSuccessText() // Set it if you want to change the Success text in Liveness screen
    ekycConfiguration.isThaiOnly = false
    ekycConfiguration.enableSecurityProtection = true // Default is false
    ekycConfiguration.enableManualCaptureMode = false // Default is false, SDK will using ML and auto capture 
             // when detected IDCard frame (Both Normal/ Hologram mode)
    ekycConfiguration.customStartPageURL = "https://www.google.com" // when start sdk this url will show as a first page. 
   
    EKYCService.shared.setConfiguration(configuration: ekycConfiguration)
   

   
   

3. Start EKYC:

   Swift

   EKYCService.shared.startMainViewController(controller: self, frame: frame)
   

🚧

If you use UIKit, EKYCService.shared.startMainViewController(controller: self, frame: frame) should be in viewDidLoad()

EKYC Delegate

In override func viewDidLoad() add:

Swift

EKYCService.shared.delegate = self

then make the class implement EKYCDelegate to override these functions:

Swift

extension ViewController: EKYCDelegate {
    
    // When EKYC started
    func onEkycStarted() {}
    
    // When EKYC stopped
    func onEkycStopped() {}
    
    // When EKYC has error (general, security, sslPinning)
    func onEkycError(error: EError) {}

    // Get status of EKYC url (verified, completed, expired, retry)
    func onEkycStatus(status: EStatus, payload: [String : Any]) {}
}

📘

To track EKYC status, please refer this section:

Tracking EKYC status

Custom Status Delegate

Swift

EKYCService.shared.customStatusDelegate = self

then make the class implement CustomStatusDelegate to override these functions

Swift

// when finish flow (DASHBOARD, LEVEL2)
func onCustomStatus(status: String) {
    print("GOTO: \(status)")
}

Stop/Remove EKYC view

Swift

EKYCService.shared.stopMainViewController()

Swift

let items = [APMSecurityItem]()
EKYCService.shared.turnOffItems(items: items)

Avoid location permission asking popup

if your requirement don't want to use dipchip flow please add below code to avoid asking location permission popup

Swift

EKYCService.shared.turnOffDipchipFlow()

---

enableManualCaptureMode

if you are using auto capture for ocr, and want to disable auto capture you can set enableManualCaptureMode to true.

Swift

	ekycConfiguration.enableManualCaptureMode = true

Turn off DipChip flow

On IOS, it takes a very long time to fetch the location to submit on DipChip flow, so EkycSDK requests the location when starting Ekyc process (The Location request popup will shown at this time).

We can turn off this feature by calling EKYCService.shared.turnOffDipchipFlow()before startMainViewController. This also makes the Location request popup not show.

---

SDK Security

AppManEKYC provides a mechanism to secure applications with these protections:

APMSecurityItem	Description	Error Code	Sub Error Code
EMULATOR	This device is emulator	1	0
JAILBROKEN	This device is jailbroken	2	0
DEBUG	This device is attaching to debugger	3	0
REVERSE_TOOLS	This device has evidence of reverse engineering	4	0
PROXY	This device is acted as a proxy	5	0

• Update Info.plist (Optional, the app can run normally without this)

There is a check in jailbreak detection module that uses canOpenURL(_:) method and requires specifying URLs that will be queried.

YAML

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>undecimus</string>
    <string>sileo</string>
    <string>zbra</string>
    <string>filza</string>
    <string>activator</string>
</array>

• Enable Security:

Swift

ekycConfiguration.enableSecurityProtection = true

• Skip the security item in the list: import APMSecurity, then:

Swift

let items = [APMSecurityItem]()
EKYCService.shared.turnOffItems(items: items)

Swift

let items = [APMSecurityItem]()
LiveNessMatchChecker.shared.turnOffItems(items: items)

---

Third-party libraries

EKYC SDK also uses third-party libraries to build its features, these are some libraries inside and their version:

Name	Version
CocoaLumberjack	3.8.2

---

Example Project

Refer to this Example App to see how EkycSDK work

terminal

git clone https://[e-mail]/appman-agm/mac-identity-verification-ios-example.git

---

FAQs

Build time errors

Q: How can I resolve this kind of compile error?

👍

A:

• Add this code block to your Podfile. Remove Pods folder and Podfile.lock and then run pod install again

post_install do |installer|
  installer.generated_projects.each do |project|
    project.targets.each do |target|
      target.build_configurations.each do |config|
        config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
        if target.name == 'Sentry'
          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'
        end
        if target.name == 'SentryPrivate'
            config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'
        end
        if target.name == 'IOSSecuritySuite'
            config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'
        end
      end
    end
  end
end

So your final Podfile will be like this

Feature behavior issues

Q: I got infinite recursive loop when finished capture image. How can I fix it?

👍

A:

To fix recursive loop to capture image, this function

EKYCService.shared.startMainViewController(controller: self, frame: frame)

should not be called in viewDidAppear(:)_ which will be triggered this function every time after camera gone because of ViewController life cycle