SDK for iOS 

Introduction 

The IDEMIA VerifyPro SDK for iOS provides customers with the resources to customize the SDK to their preferred user-experience and integrate it within an existing mobile application. The IDEMIA Mobile ID Verify App works in conjunction with the IDEMIA Mobile ID App allowing verifiers to authenticate the user's physical ID or digital credential (i.e., drivers license or identity card).

You can use the iOS SDK to:

• **Create and design your preferred user-experience and UI while leveraging the IDEMIA VerifyPro functionalities **

  You can build a custom mobile application that implements your user-experience design and leverages all of the SDK functionalities allowing you to apply your branding and preferred user flow. Maintain complete control over the display and functionality of the application.

• **Embed IDEMIA VerifyPro into an existing application **

  You can automatically integrate an existing mobile application with IDEMIA by adding the SDK frameworks, which removes the need to use and maintain an additional application to leverage the Mobile ID's functionalities.

Get started 

Skills required 

The integration tasks require developers to have knowledge of:

• iOS frameworks built in Xcode 15.1 or higher
• Swift 5.0 or higher
• Mac OS 14.1 or higher

Resources required 

The tools required for integration on macOS are:

• Xcode 15.1 or above
• iOS SDK tools: release 15.x to 18 Beta
• Physical iOS device (simulator is not supported)

Other requirements

External Libraries

• pod 'SwiftCBOR', '0.4.7'
• pod 'EventsEmitter', '0.0.2'

User permission 

When designing your app,consider that your iOS app must handle user permissions to protect the resources on the target mobile device. Specifically, you must verify that the app permissions are granted by the user. If the required permissions are not granted, the SDK will throw an exception or error and may even crash.

The following user permission are required:

• Camera permission for the QR code scan
• Bluetooth permission for the BLE data transfer
• NFC permission for the device engagement

The required permissions in the app info.plist file are:

• Privacy: Bluetooth Always Usage Description
• Privacy: Bluetooth Peripheral Usage Description
• Privacy: Camera Usage Description
• Privacy: NFC Usage Description

Capability 

If the integrator wants to use NFC as Device Engagement.

The following steps are required:

Project Target -> Signing & Capabilities -> + Capability -> Near Field Communication Tag Reading

Create your own app 

If you already have access for Mi-Artifactory, download the sample app: https://mi-artifactory.otlabs.fr/artifactory/verify-pro-sdk-ios-release/com/idemia/idverify/ios/4.2.0/Sample/4.2.0-sample-ios.zip

To create your own app, you must add the following SDK libraries to your project. You can add these libraries manually as shown in Option A, or through CocoaPods as shown in Option B.

Add SDK libraries 

The Podfile specifies the dependencies of each target, and the SDK pods are used to declare a specific dependency. The target scopes the pod dependencies to specific targets in your Xcode project.

Required pods

• pod 'SwiftCBOR', '0.4.7'
• pod 'EventsEmitter', '0.0.2'

Option A: Import VerifyPro SDK manually

The manual method allows you to import the SDK files using VerifyPro.framework using the steps below:

1. Download the VerifyPro.framework and Tester app from the mi-artifactory: https://mi-artifactory.otlabs.fr/artifactory/webapp/#/artifacts/browse/tree/General/verify-pro-sdk-ios-release/com/idemia/idverify/ios/

2. Add the VerifyPro.framework file to your project by pasting this file in project folder at path: ~/Frameworks/VerifyPro.framework.

3. Link and Embedd VerifyPro.framework to your project by dragging and dropping it on Project Settings (General > Frameworks, Libraries, and Embedded Content).

4. At the top of your project Podfile add the lines shown in the snippet:

   Swift
   1plugin 'cocoapods-art', :sources => [
   2    'master' # so it could resolve dependencies from master repo (the main one)
   3]

5. Add following pod dependency (Follow the 1,2 steps from section Option B for repository access)

• pod 'SwiftCBOR', '0.4.7'
• pod 'EventsEmitter', '0.0.2'

6. Add the following line in end of your Podfile (refer the sample code) to avoid linker error of any pod dependencies of VerifyPro.

   Swift
   1post_install do |installer|
   2 installer.pods_project.targets.each do |target|
   3 target.build_configurations.each do |config|
   4 config.build_settings.delete 'IPHONEOS_DEPLOYMENT_TARGET'
   5 config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
   6 end
   7 end
   8 end

Option B: Import VerifyPro SDK through CocoaPods with other dependencies (Recomended option)

Alternatively, the CocoaPods method allows you import the SDK files using CocoaPods (along with cocoapods-artplugin) using these steps.

1. If you don't already have CocoaPods with the Artifactory tool, install it by running the following command as shown in the snippet:

   Swift
   1gem install cocoapods-art

2. The plugin uses authentication that is specified in a standard .netrc file, as shown in the snippet:

   Swift
   1machine mi-artifactory.otlabs.fr
   2login ##USERNAME##
   3password ##PASSWORD##

3. At the top of your project Podfile add the lines shown in the snippet:

   Swift
   1plugin 'cocoapods-art', :sources => [
   2    'verify-pro-sdk-ios-release', # so it could resolve dependencies for VerifyPro
   3    'master' # so it could resolve dependencies from master repo (the main one)
   4]

   NOTE: If you do not have podfile already created, use the following commands to create one

   Swift
   1pod init

4. Once set, add our repository to your CocoaPod's dependency management system as shown in the snippet:

   Swift
   1pod repo-art add verify-pro-sdk-ios-release "https://mi-artifactory.otlabs.fr/artifactory/api/pods/verify-pro-sdk-ios-release"

5. Add the VerifyPro SDK in your Podfile in one of its pod's version, as shown in the snippet:

   Swift
   1pod 'VerifyPro', '~> 4.2.0.131' # VerifyPro SDK

6. Now install or update as shown in the snippet:

   Swift
   1pod install or pod update

   NOTE: If you are already using our repository, and you cannot resolve some dependency, try to update the specs:

   Swift
   1pod repo-art update verify-pro-sdk-ios-release

7. Add the following line in end of your Podfile (refer the sample code) to avoid linker error of any third party dependencies of Verify.

   Swift
   1post_install do |installer|
   2 installer.pods_project.targets.each do |target|
   3 target.build_configurations.each do |config|
   4 config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
   5 end
   6 end
   7 end

SDK API’s and methods 

The SDK is made up of following components:

1. IDVerify Acts as the Entry Point for initializing device engagement, sending the request, by preparing a connection to the Mobile ID holder, receiving a response, and sending parsed model back to the calling app

• initializeSdk

  Language not specified
  1/* Call this method to initialize the sdk. It's manadatory to call this api before calling any other api. This API should be called before calling any other api.
  2 @param lkmsConfigs: License configs object containing valid credentials.
  3 @param Parameter callback: LicenseCallback object to  be retuened based on the  result.
  4 */
  5 public static func initializeSdk(lkmsConfigs: LkmsConfig, callback: LicenseCallback) {
  6 }

• initDeviceEngagement

  Language not specified
  1/* Call this method from UI Application to parse the scanned qrcode
  2- @param configParams: Send the parameters e.g. inputData, license attribute params e.g. AGE_OVER_NN
  3- @param responseCallback: callback to receive the model object/errors corresponding to the passed-in QRCode
  4*/
  5public func initDeviceEngagement(apiConfig configParams: ApiConfigs?, responseCallback: UIViewController)

• prepareConnection

  Language not specified
  1/* Initialize and setup connection components as per`ConnectionConfigs` configurations supplied
  2- @param configParams: configurations for connection related information  
  3- @param callback: callback to connection status back to app
  4- Create communication channel (BLE) as per device engagement data
  5 */
  6 public func prepareConnection(configParams: ConnectionConfig?, responseCallback: (Any)?)

• sendRequest

  Language not specified
  1/* send request to Mobile ID based on the use case selected by user in Verify application
  2- @param apiConfigs: configurations and optional MID request params  
  3- @param callback: callback to send progress and response data back to app
  4- 1. create Mobile ID request based on supplied USECASE or parameres/configs
  5- 2. onCreate communication channel (BLE/NFC/wifiAware ...) as per engagement data
  6- 3. send request to Mobile ID on communication chanel
  7- Note- In future we may also use USECASE : use case identifier required to prepare desired request data
  8 */
  9 public func sendRequest(apiConfig configParams: ApiConfigs?, responseCallback: UIViewController)

• terminateConnection

  Language not specified
  1/* Terminate connection available with Mobile ID.
  2- @param responseCallback: callback to receive the model object/errors corresponding to the passed-in qrcode
  3- @param cancellationReason: Send the enum of cancellationReason e.g. TIMEOUT, CANCELED_BY_USER,  CONNECTION_ERROR and NONE
  4 */
  5 public func terminateConnection(responseCallback: Any?, cancellationReason: CancellationReason)

• terminateSession

  Language not specified
  1/* It terminate the current session and terminate the connection as well.
  2- @param responseCallback: callback to receive the model object/errors corresponding to the passed-in qrcode
  3- @param cancellationReason: Send the enum of cancellationReason e.g. TIMEOUT, CANCELED_BY_USER,  CONNECTION_ERROR and NONE
  4 */
  5 public func terminateSession(responseCallback: Any?, cancellationReason: CancellationReason)

• loadCertificates

  Language not specified
  1/* Load IACA certificates from given path by application (libraryDirectory path)
  2 -  @param path is the Directory (libraryDirectory type) folder name(created by integrator)from where SDK will load the certificate, refer the sample.
  3 -  @param responseCallback is callback to return success(will return loaded certificate count) or error
  4 */
  5    public func loadCertificates(path: String?, responseCallback: Any?)
  6    
  7* Using the direct IACA certificates loading.    
  8How to create directory structure for hosting IACA files for your Reader app?
  9- Create the libraryDirectory named "idemiacerts" which should be accecisble at runtime
  10- Copy or download IACA files at the libraryDirectory named "idemiacerts"
  11- Refer the sample application for code snippet.[Class - VenderCertificateManager.swift]
  12
  13
  14* Using Vical Structure for IACA loading 
  15How to create directory structure for hosting vical files for your Reader app?
  16- Create the libraryDirectory named "idemiavical" which should be accecisble at runtime
  17- Copy below directory structure containing vical files in "idemiavical" folder.
  18- Create new directory Vical inside "idemiavical" and copy .vical and .pem files for each environment as per below structure.
  19- Refer the sample application for code snippet.[Class - VenderCertificateManager.swift]
  20 idemiavical/Vical
  21   /Dev
  22     - iaca.vical
  23     - iaca.vical.pem
  24   /UAT
  25     - iaca.vical
  26     - iaca.vical.pem
  27   /PROD
  28     - iaca.vical
  29     - iaca.vical.pem
  30    
  31 How To configure vical from app directory?
  32- Create 'BundleFolder/Vical' folder in app bundle. Refer the sample application.
  33- Copy vical file and corresponding ca cert file per environment similar to structure defined above.
  34- Set value as "idemiavical" for `path` while calling `loadCertificates` api and verifySDK will get the file from "idemiavical" library path folder.

Api implementation steps 

1. Initialize the ID Verify SDK by providing a valid license information in initializeSDK API. Best way to do it is when your application's Home View Controller is loaded:

Swift
1HomeViewController: LicenseCallback {
2    
3    override func viewDidLoad() {
4        // Use following code to initialize SDK with your license configuration provided 
5        let lkmsConfig = LkmsConfig(serverUrl: LICENSE_URL, profileId: PROFILEID, apiKey: APIKEY)
6        IDVerify.initializeSdk(lkmsConfigs: lkmsConfig, callback: self)
7    }
8
9     //MARK:  onSuccess
10    func onSuccess() {
11        print("License retrieved successfully")
12    }
13    
14    //MARK: onError
15    func onError(error: Any?) {
16        print("License error")
17    }
18}

2. Scan the QR codes or NFC Tags as shown in the snippet:

   Swift
   1/**
   2 * Response callback for parse engagement QR code data or **Mobile ID** credential holder
   3 */
   4  //MARK:  parsed QRCode
   5  func parsedDataForQRCode(trimmedQRCode: String){
   6      DispatchQueue.global(qos: .default).asyncAfter(deadline: .now() + 0.2) {
   7          let config = self.formAndReturnAppConfigsParamForAPI(qrString: trimmedQRCode)
   8          sharedVSDKClient?.initDeviceEngagement(apiConfig: config, responseCallback: self)
   9      }
   10  }
   11
   12  // Returns ApiConfigs with all the parameters
   13  func formAndReturnAppConfigsParamForAPI(qrString qr: String?) -> ApiConfigs? {
   14      guard let tempQRString = qr else {
   15          return nil
   16      }
   17      
   18      // Build app configs for BLE
   19      let apiConfigs = ApiConfigs.ConfigBuilder()
   20          .withData(inputData:tempQRString)
   21          .build()
   22      return apiConfigs
   23      
   24      // Build app configs for NFC Engagement
   25      let apiConfigs = ApiConfigs.ConfigBuilder()
   26      .useNFC()
   27      .build()
   28      return apiConfigs
   29  }

3. After scanning the QR successfully, you will get the result response in onSuccess as shown in the snippet:

   Swift
   1func onSuccess(response: Any?){
   2  }
   3  func onError(error: VerifyError){
   4  }

4. Call prepareConnection API

   The prepareConnection() method will prepare the connection based on device engagement with Mobile ID credential. If it received successfully, Integrator can send the request on prepared connection channel.

   Swift
   1// Set 'ConnectionConfig' as follows for setting the connection related information. 
   2
   3let connectionConfig = ConnectionConfig()
   4    .setConnectionType(type: ConnectionType.BLE)
   5sharedVSDKClient?.prepareConnection(configParams: connectionConfig, responseCallback: self)

   Swift
   1// Set 'setL2CapRequestSupport' as true to enable L2CAP mode during BLE communication. 
   2
   3let connectionConfig = ConnectionConfig()
   4    .setConnectionType(type: ConnectionType.BLE)
   5    .setL2CapRequestSupport(l2CapRequestSupportEnable: true)
   6sharedVSDKClient?.prepareConnection(configParams: connectionConfig, responseCallback: self)

   Swift
   1// prepareConnection api by using `connectionConfig` which you set earlier
   2sharedVSDKClient?.prepareConnection(configParams: connectionConfig, responseCallback: self)

Callback for the prepareConnection API to receive connection status**.

Language not specified
1```Swift
2
3    /**
4     * Request callback for the `prepareConnection` SDK API to receive connection status.
5     */
6
7    func connectionSuccessful(connectionType: ConnectionType) {
8    }
9
10    func connectionError(error: Any?) {
11    }
12
13    func currentStatus(currentState: TransferState){
14    }
15
16    func onConnectionCanceled(response: Any?) {
17    }
18        
19```

5. Send a request to the Mobile ID App to get the license details as shown in the snippet:

Language not specified
1The `sendRequest()` method will return the response from the end-user's **Mobile ID** credential. If it's received it successfully, then all the attributes of the **Mobile ID App** response appear in the view controller.
2
3```Swift
4// Set 'appConfig' as follows if you want to use all attributes as optional parameters
5var dataItems = getMandatoryParams()
6dataItems.append(contentsOf: getOptionalParams())
7
8let apiConfigs = AppConfigs.MIDRequestBuilder()
9            .addParam(listParams: dataItems)
10            .build()
11```
12
13```Swift
14// Set 'appConfig' as follows if you want to use only the suggested attributes as optional parameters
15var dataItems = getOptionalParams() let apiConfigs =
16AppConfigs.MIDRequestBuilder() .addParam(listParams: paramsList, useDefaults:
17true) .build()
18```
19
20```Swift
21//Send the request by using `appConfig` which you set earlier
22sharedVSDKClient?.sendRequest(apiConfig: apiConfigs, responseCallback: self)
23}
24```
25
26```Swift
27// Sample code for L2Cap Support in Api config. Set L2CapRequestSupportEnable as true for enabling L2cap support.
28let apiConfigs = ApiConfigs.MIDRequestBuilder()
29                    .version(version: MIDParamConstants.REQUEST_VERSION)
30                    .setL2CapRerquestInfo(L2CapRequestSupportEnable: true)
31                    .addParams(MIDParamConstants.NAMESPACE_18013_5,isoParamsList)
32                    .build()
33```
34
35```Swift
36// send request using new namespace and paramList support
37        func sendrequest(){
38    
39    var aamvaParamsList = [MIDRequestParam]()
40    var namespaceParamList = [String: [MIDRequestParam]]()
41    var isoParamsList = [MIDRequestParam]()
42    isoParamsList.append(MIDRequestParam(paramName: MIDParamConstants.GIVEN_NAME))
43    isoParamsList.append(MIDRequestParam(paramName: MIDParamConstants.FAMILY_NAME))
44    isoParamsList.append(MIDRequestParam(paramName: MIDParamConstants.RESIDENT_ADDRESS))
45    isoParamsList.append(MIDRequestParam(paramName: MIDParamConstants.RESIDENT_CITY))
46    isoParamsList.append(MIDRequestParam(paramName: MIDParamConstants.RESIDENT_CITY))
47    
48    namespaceParamList[MIDParamConstants.DOCTYPE_ORG_AAMVA_US] = aamvaParamsList
49    namespaceParamList[MIDParamConstants.NAMESPACE_18013_5 ] = isoParamsList
50    
51    let apiConfigs = ApiConfigs.MIDRequestBuilder()
52        .version(version: MIDParamConstants.REQUEST_VERSION)
53        .addDocType(docType: "my.cusom.docType.custom1") //example docType1
54    
55    //1. add
56        .addParams(namespaceParamList)
57    // add again to test if duplicates are removed
58        .addParams(MIDParamConstants.NAMESPACE_18013_5,isoParamsList)
59    //2. add more params one by one with custom namespce
60        .addParam(MIDParamConstants.NAMESPACE_18013_5,MIDRequestParam(paramName: "custom_param1"))
61        .addParam("my.custom.namespace",MIDRequestParam(paramName: "custom_param1"))
62    
63        .addParam("my.custom.namespace",MIDRequestParam(paramName: "custom_param2"))
64        .addParam("my.custom.namespace",MIDRequestParam(paramName: "custom_param3"))
65    //duplicates will be removed
66        .addParam("my.custom.namespace",MIDRequestParam(paramName: "custom_param1"))
67        .addParam("my.custom.namespace",MIDRequestParam(paramName: "custom_param3"))
68    //3. or add a custom namespace like this
69        .addParams("my.custom.namespace2", [
70            MIDRequestParam(paramName: "custom_param_nm21"),
71            MIDRequestParam(paramName: "custom_param_nm22"),
72            MIDRequestParam(paramName: "custom_param_nm23"),
73            MIDRequestParam(paramName: "custom_param_nm21") ]//duplicate
74        )
75    
76        .buildDoc()  //build doctype1
77        .addDocType(docType: "my.cusom.docType.custom2") //example docType2
78        .addParams("my.custom.namespace2", [
79            MIDRequestParam(paramName: "custom_param_nm21"),
80            MIDRequestParam(paramName: "custom_param_nm22"),
81            MIDRequestParam(paramName: "custom_param_nm23"),
82            MIDRequestParam(paramName: "custom_param_nm21") ]//duplicate
83        )
84        .buildDoc() //build doctype2
85    
86        .build()
87    
88    //call sendRequest API
89    sharedVSDKClient?.sendRequest(apiConfig: apiConfigs, responseCallback: self)
90    // 3. Read request params supplied from app and make the request structure accordingly.
91    
92}
93```

6. Callback for the sendRequest API to receive and display the response data from the Mobile ID App.

Language not specified
1```Swift
2/**
3 * Request callback for the `sendRequest` SDK API to receive and display the response data from the mDL.
4 */
5
6func onSuccess(response: Any?){
7}
8func onError(error: VerifyError){
9}
10func onRequestCanceled(response: Any?){
11}
12func onProgress(totalBytesRecived: Int){
13}
14func onRequestSent(status: Bool?){
15}
16func currentBLEStatus(currentState: TransferState){
17}
18
19// onSuccess callback method for handling Multi request reqsponse
20func onSuccess(response: Any?, callback:MultiRequestCallback?) {
21}
22
23// On next callback is used for sending next request in same session. 
24func onNext(apiConfigs:ApiConfigs){
25}
26
27// Terminate connection method is used for terminate session in Multirequest.
28func onTerminateConnection() {
29}
30
31 /**Set Multi Request Info.
32 - Parameter multiRequestEnable: Set for identify request is Multi Request supported
33 - Returns: MIDRequestBuilder object
34 */
35public func setMultiRerquestInfo(multiRequestEnable: Bool) -> MIDRequestBuilder {
36    self.isMultiRequest = multiRequestEnable
37    return self
38}
39
40// Sample code for multi request Api config
41let apiConfigs = ApiConfigs.MIDRequestBuilder()
42                        .version(version: MIDParamConstants.REQUEST_VERSION)
43                        .setMultiRerquestInfo(multiRequestEnable: VerifyAppManager.sharedInstance.getMultiRequestMode() ?? false)
44                        .addDocType(docType: MIDParamConstants.DOCTYPE_18013_5)
45                        .addParams(MIDParamConstants.NAMESPACE_18013_5,isoParamsList)
46                        .addParams(MIDParamConstants.NAMESPACE_ORG_AAMVA_US,aamvaParamsList)
47                        .addRequestInfo(key: "attributesInfo", value: attributeInfoMap())
48                        .build()
49 ```

Step and sample code for Reader Authentication(Signature only)[optional].

Language not specified
Swift
11. Add/Enable the callback in the RequestBuilder.
2
32. Implement the readerAuthSignerCallback at app side. readerAuthSignerCallback provides the interface to perform signing of readerAuthentication structure. Verify SDK will call doSignRequest with the readerAuthentication structure to sign by the integrator with the reader private key. They will sign the bytes using certificate private key and return ReaderAuthSign data model with generated signature, algorithm used to sign and a x509 certificate with the corresponding public key of the private key that the readerAuthenticationBytes structure is signed.[Refer 9.1.4 mdoc reader authentication ISO/IEC FDIS 18013-5:2021(E) page 54]
4
53. List the required resources e.g cert, keys at Integrator side.
6An mdocReader private key to sign the Reader Auth structure. the resulting signature and algorithm used to sign shall be included within the mdoc request to be sent to mdoc.
7CA signer certificate containing the corresponding public key of the private key used in signing which shall be sent to mdoc within the mdoc request. Integrator would submit a CSR to a valid CA to get a signer certificate.
8(Optional) CA root certificate from CA which shall be shared by Reader to mDoc Holder which they can use to authenticate the signer certificate received within Reader Request

6. You can cancel / terminate a transaction any time if an error occurs in the app as shown in the snippet:

Swift
1sharedVSDKClient?.terminateConnection(responseCallback: Any?, cancellationReason: CancellationReason)

6.1. To terminate the running connection and session use terminateSession API. This API is available only in IDVerify client

Swift
1sharedVSDKClient?.terminateSession(responseCallback: Any?, cancellationReason: CancellationReason)

7. You can get the SDK version by calling it directly with the class name as shown in the snippet:

   Swift
   1IDVerify.version

8. Added new configuration setReaderAuthInfo for reader authentication; here is a sample code snippet:

   Swift
   1let apiConfigs = ApiConfigs.MIDRequestBuilder()
   2    .version(version: MIDParamConstants.REQUEST_VERSION)
   3    .addDocType(docType: "org.iso.18013.5.1.mDL")
   4    .addParams(namespaceParamList)
   5    .buildDoc()
   6    .setReaderAuthInfo(readerAuthSignerCallback: self.callbackReceiverVC, signingAlgo: .ALGO_SHA256WITHECDSA)
   7    .withData(inputData: MOCK_QR_CODE_DATA_N1938)
   8    .build()

9. Added new protocol ReaderAuthSignerCallback for reader authentication callback; here is a sample code snippet of implementation:

   Swift
   1extension ViewController: ReaderAuthSignerCallback {
   2    func doSignItemRequest(readerAuthenticationBytes: Data, docType: String) -> ReaderAuthSign? {
   3        //Generating Public Private KeyPair
   4        let keyPairDict = try? ECUtils.generateKeyPair()
   5        let privateKey = keyPairDict?["private"]
   6        //Generating Signature
   7        let signedDataSignature = (try? EncyptionDecryption.createSignature(privateKey: privateKey, dataToSign: readerAuthenticationBytes, algorithm: .ecdsaSignatureDigestX962SHA256)) ?? Data()
   8        //returning Signature and Certificate
   9        return ReaderAuthSign(signature: signedDataSignature, x509Certificate: x509CertSample.bytes.getData())
   10        }
   11}

10. Call loadCertificates() API to load IACA certificates from given path(libraryDirectory path) and provides the number of certificats loaded as response(Int). This step is necessary for a successful transaction since VerifyPro SDK will validate the mDL response against the certificates from supplied path. Refer sample Application.

Swift
1sharedVSDKClient?.loadCertificates(path: "CERTIFICATEDIRECTORY_NAME", responseCallback: self())
2    func onSuccess(response: Any?){
3        print("Certificate load success \(response)")
4    }
5    func onError(error: Any?){
6        print(error)
7      }

11. Call setDisconnectBleTimeout() method to set BLE disconnect timeout time from app side. Default timeout is 3 sec.

Swift
1let sharedClient = self.getVerifySDKClient()
2  let configs = ApiConfigs.ConfigBuilder().withData(inputData: "").useBLE().setDisconnectBleTimeout(time: 5).build()

Step and sample code for CRL Data Downloader Callback [optional].

12. Added configuration setCRLDataDownloaderCallback for IACA's CRL data download and send back to sdk for verification. "crLDownloaderCallback": The callback handler, This might be a delegate or a class that implements a specific method for processing the downloaded CRL data. "isCrlForceDownload": true or false: This parameter indicates whether the CRL should be downloaded forcefully, bypassing any cache or previously stored CRL data, the default value for isCrlForceDownload is false. timeout

    This integer specifies the timeout duration in seconds. If the CRL download takes longer than this period, the operation will be aborted to avoid delaying the transaction verification. This ensures that your application remains responsive even if the CRL download encounters issues. The default value of timeout is 3 seconds by SDK. here is a sample code snippet:

    Swift
    1public func setCRLDataDownloaderCallback(crLDownloaderCallback: CRLDataDelegate, timeout: Int, isCrlForceDownload: Bool) -> MIDRequestBuilder

    Swift
    1let apiConfigs = ApiConfigs.MIDRequestBuilder()
    2   .version(version: MIDParamConstants.REQUEST_VERSION)
    3   .addDocType(docType: "org.iso.18013.5.1.mDL")
    4   .addParams(namespaceParamList).buildDoc()
    5   .setCRLDataDownloaderCallback(crLDownloaderCallback: self, timeout: 5, isCrlForceDownload: true)
    6   .build()

13. Added protocol CRLDataDelegate for CRL Data Downloader callback; here is a sample code snippet of implementation - you can refere the class "CRLDataCacheUtility.swift" from sample application. Returns Result with CRL data list or error if any.

Swift
1extension ViewController: CRLDataDelegate {
2    func fetchCRLData(from urls: [URL], completion: @escaping (Result<[Data], Error>) -> Void) {
3        ///Here integrator can download the CRL data from given URL or uRLs and send back to SDK 
4        CRLDataCacheUtility().downloadData(from: urls, completion: completion)        
5     }
6   }

Test and production apps 

The VerifyPro SDK allows you to create a test app with the steps below. You can also use these steps to create your production application by changing the target definition in your Podfile to your Xcode production project.

1. Open your terminal and type the command "cd project_path" (the path to the project file where .xcodeproj file is located) and press .

2. Type the command "pod init" and press .

3. Go to the finder and open the pod file (in the same place where your .xcodeproj file is located).

4. Type the following in podfile under your target. In our case, the target is VerifyIDTestApp; change it according to your target in podfile and add the snippet shown:

   Language not specified
   1target 'VerifyIDTestApp' do
   2  use_frameworks!
   3  pod 'VerifyPro', '~> 4.2.0.131'
   4
   5  target 'VerifyIDTestAppTests' do
   6    inherit! :search_paths
   7    # Pods for testing
   8  end
   9
   10  target 'VerifyIDTestAppUITests' do
   11    # Pods for testing
   12  end

5. Type the command “pod install” and then press .

6. Open .xcworkspace (i.e., at the same place where your .xcodeproj file is located).

7. Call IDVerify.getClient and initialize the IDVerify shared object in the AppDelegate.swift file as shown in the snippet:

   Swift
   1let config = Configs.Builder()
   2     .enableDebug(isDebuggable: isDebuggable)
   3     .build()
   4
   5 sharedVSDKClient = IDVerify.getClient(configs: config)

Swift
1/**
2 *   LogLevel enum : Option to set log levels. Integrator can pass multiple values as LogLevel Array.
3 */
4 VERBOSE - Use this option for all logs
5 TRANSACTION_TIME - Use this option for time logs
6 TROUBLESHOOTING - Use this option for troubleshooting logs
7 DEBUG_NO_PII - Use this option for all NO-PII logs
8 NONE - Use this option for No logs (Default Log level)

9. Use enableDebug(logLevelArr: [LogLevel.VERBOSE]) for debugging purposes only if needed, as shown in the snippet:

   Swift
   1let config = Configs.Builder()
   2  .enableDebug(logLevelArr: [LogLevel.VERBOSE]) // multiple option can be passed. Default is LogLevel.NONE
   3  .build()
   4
   5 
   6 **To get instance of IDVerify-**
   7 sharedVSDKClient = IDVerify.getClient(configs: config)

Request Parameters 

The following table provides a list of attributes which can be configured for sendRequest API.

Expected Results 

QR code

Below are expected response from the sendRequest API with the expected data type.

IACA certificate file format support 

• Supports following formats for IACA certificates - (.pem, .crt, .der).

Elliptic curve support 

ISO-18013-5 specification support 

Additions and updates 

• ISO Amendments N2448 (v1.1 Draft7):
  • Device engagement implementation for N2448 with backwards compatibility support
  • NFC Static+L2cap PSM functionality for mdoc Peripheral mode
  • ReaderAuthAll Implementation for N2448
• Implemented callback for downloading CRL data from the integrators application
• Compatible with iOS 18 Beta
• Bug fixes and Improvements

Notes:

• IDEMIA has many IACA certificates added to our Verify App, so we must categorize these certificates, such as Production, Demo, UAT, in our App. This allows the Verify App integrator to know which certificate matches pertain to which environment at any time during a transaction.
• A certificate validation match is performed with the Mobile ID credential, and a certification tag is created for every certificate. This flag is used used in the Verify SDK to distinguish between different purposes of the certifications, leading to indicators in the Verify App results screen that some Mobile IDs credentials are “Not for Official Use”. If a certificate is not in production, then it is not meant for official use.
• A popup/updated UI on the Verify App displays whether the Mobile ID credential is applicable for official use or not, based on the matched IACA certificate. Currently, for integrators, this provides additional information for IACA certificate matching.
• The classification of these certificates is shown in this link: https://idemiadigitallabs.atlassian.net/wiki/spaces/MI/pages/478052581/IACA+Certificates
• Verify SDK support following file formats for IACA certificates - (.pem, .crt, .der)
• NFC implementation for Device Engagement (It only supports Static Device Engagement)

Error codes 

This table contains the list of data error codes, messages, descriptions, and actions required.

Test samples 

QR + BLE sample 

The following screen shows a scan of QR code in the IDEMIA Mobile ID App.

Note: This is for device engagement QR code testing. The full QR code + BLE scenario will only work with a real device using the IDEMIA Mobile ID App.