iOS SDK

Information about the iOS SDK

The iOS SDK includes a core native library (closed-source) and a reference UI implementation provided in source code format. This setup allows you to fully customize the UI according to your application’s requirements. While this page provides an overview, you can read more detailed documents at iOS SDK Documentation.

The iOS SDK comes in two variants:

• Online: This variant is small in size, but it needs to connect with the server for SensePrint eID verification/decryption.

• Offline: This variant is larger in size, but it can be used to verify/decrypt SensePrint eIDs with no network connectivity and completely on a mobile device.

  • OfflineLight: Same as Offline but the model files are not bundled with the app. Instead the models can be downloaded and the location of the downloaded models are provided in the SDK init function.

Both variants utilize the same reference UI implementation. This means the same Swift source code is used for both variants. In the provided XCode workspace there are two XCode projects that point to the same source files. Based on the selected schema you can either build & run the online or offline app variant.

Constants

The Constants files specify configuration parameters that can be set before compile time. The below screenshot shows the location of the Constants files for the Online and Offline variant:

Location of the Constants files in Xcode

Constants shared among online & offline SDK

• GENERATION_CAPTURE_MODE - the face capture method used while generating a SensePrint. Can be one of FaceCaptureMode.ActiveCaptureFrontCamera, FaceCaptureMode.PassiveCaptureFrontCamera, or FaceCaptureMode.PassiveCaptureBackCamera.

• VERIFICATION_CAPTURE_MODE - the face capture method used while verifying a SensePrint. Can be one of FaceCaptureMode.ActiveCaptureFrontCamera, FaceCaptureMode.PassiveCaptureFrontCamera, or FaceCaptureMode.PassiveCaptureBackCamera.

• SENSEPRINT_VERIFIER_AUTH_KEY - It is possible to generate SensePrint eID QR codes targeted at a specific verifier. See the section on Generating your first SensePrint eID QR. When the verifiers_auth_key attribute is specified while generating the QR, that QR code can only be read by a specific verifier. Set the value of SENSEPRINT_VERIFIER_AUTH_KEY to the value you used for verifiers_auth_key while generating the QR code.

• SDK_MODE - whether the current SDK mode is Offline or Online (as changed by the gradle task)

• DEBUG_FOR_SAVING_IMAGES - if turned on images are saved to Phone Storage for debug purposes.

• CONFIG_JSON_FILE_NAME - Json File to load the config from.

Constants for online SDK

• API_SERVER_URL - this value should point to your server that you deployed using the Docker. If you exposed the server using ngrok use the Ngrok URL value.

• AUTH_HEADER - this value should be set to the mobile_api_key value you used in the secrets.json file while starting the Docker container for the server. If you are using a JWT Token for mobile authorization, this should be set to Bearer your_jwt_token_from_server

Constants for offline SDK

• ISSUERS_PUBLIC_KEY - this value is present only in the offline SDK. If you started the server in Certificate Authority mode by setting the issuers_private_key, then the server will issue signed SensePrints. In order to verify them, you must set the corresponding ISSUERS_PUBLIC_KEY in the Constants. For more information checkout our overview.

• CUSTOM_MODEL_PATH - The location to load the models from in offlineLight.

• MODELS_DOWNLOAD_FILE_URLS - URL to download the models from in offlineLight.

Important Views

1. SplashScreen

   Responsible for initializing the SDK and loading the necessary Machine Learning models into memory. This is the first view triggered when the application launches. The SplashScreen culminates by loading the MainView.

2. MainView A simple interface displaying entry points for SensePrint eID QR generation, verification and reading. Users can interact with buttons to proceed with either operation.

3. GenerateQRView Triggered from either the ActiveFaceCaptureView or the PassiveFaceCaptureView, this activity allows the user to input eID attributes (e.g., name, record ID) needed for QR code generation.

4. QRScannerView Scans the generated QR code containing the user’s face and other details. If the QR code is password-protected, the user will be prompted to enter the password before personal details can be decrypted.

5. PassiveFaceCaptureView This view captures a single, good image of a user using the camera. The captured image can then be used to generate/verify a SensePrint QR.

6. ActiveFaceCaptureView This view uses the camera to capture facial images but prompts the user to position their head in 3 random positions before their face is captured. This presents added security against injection attacks.

7. PersonDetailView This View contains all the details user will see after successfully scanning and decrypting a SensePrint QR code.

Additional Notes

The SDK is designed for modularity, allowing full customization of the user interface and integration flows while maintaining core functionality within a closed-source native library.

This document serves as a guide to understand and integrate the iOS SDK into your application. Be sure to configure the constants accurately to align with your deployment setup and security requirements.