Installation Guide

In this section, you will find all the information needed to install the Unico IDCloud platform SDK in your iOS applications


Development Environment Preconditions


Your development environment must meet the following prerequisites:

  • Have Xcode version 15.0.1 or higher installed (the official development IDE from Apple);

  • Have the iOS SDK version 11 or higher installed;

  • Have the dependency manager Cocoapods or Swift Package Manager configured.

The capture component provided through the iOS SDK is compatible with all devices running iOS 11 or later. You can check the list of compatible devices on the official Apple support channels.

Installing the iOS SDK


To implement the iOS SDK from the Unico IDCloud platform into your iOS application, follow the step-by-step instructions listed below:

1

Using CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For installation and usage instructions, visit the official CocoaPods documentation. To integrate the iOS SDK into your Xcode project using CocoaPods, follow the instructions below:

Include unicocheck-ios in your Podfile:

podfile
pod ‘unicocheck-ios’

Next, simply use the command in your terminal to install the dependencies:

pod install

2

Using Swift Package Manager (SPM)

Swift Package Manager is a dependency manager for Swift projects. It is integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies. To integrate the iOS SDK into your project using SPM, follow the instructions below:

Include the dependency in your Package.swift file:

Package.swift
<uses-dependencies: [
    .package(url: "https://github.com/acesso-io/unico-check-ios.git", .upToNextMajor(from: "2.12.0"))
]

3

Camera Usage Permissions

To use the camera opening method in your project, you need to add the necessary permissions before compiling your application:

Info.plist
<key>NSCameraUsageDescription</key>
<string>Camera usage description</string>

4

Obtaining Credentials

  • Contact the CSs and/or the Onboarding team.

  • Request the SDK Key by providing the identifiers of your applications: Bundle Identifier for iOS, PackageID for Android, and Host for WEB.

  • The identifiers of your applications will be linked to the SDK Key by the Unico team.

  • You will receive your SDK Key to implement the AcessoBioConfigDataSource.

5

Embedding the Credentials in Your Project

  • Implement the AcessoBioConfigDataSource protocol in your class:

.h:
#import <AcessoBio/AcessoBioManager.h>
#import <AcessoBio/AcessoBio-Swift.h>

@interface YourUnicoConfigClass: AcessoBioConfigDataSource {}
@end

.m:
@implementation YourUnicoConfigClass

- (NSString * _Nonnull)getBundleIdentifier {
    return @"<YOUR_MOBILE_BUNDLE_IDENTIFIER>";
}

- (NSString * _Nonnull)getHostKey {
    return @"<YOUR_SDK_KEY>";
}

@end
Deprecated Method - Objective-C
.h:
#import <AcessoBio/AcessoBioManager.h>
#import <AcessoBio/AcessoBio-Swift.h>

@interface YourUnicoConfigClass: AcessoBioConfigDataSource {}
@end

.m:
@implementation YourUnicoConfigClass

- (NSString * _Nonnull)getBundleIdentifier {
    return @"<YOUR_MOBILE_BUNDLE_IDENTIFIER>";
}

- (NSString * _Nonnull)getHostInfo {
    return @"<YOUR_HOST_INFO>";
}

- (NSString * _Nonnull)getHostKey {
    return @"<YOUR_HOST_KEY>";
}

- (NSString * _Nonnull)getMobileSdkAppId {
    return @"<YOUR_MOBILE_SDK_APP_ID>";
}

- (NSString * _Nonnull)getProjectId {
    return @"<YOUR_PROJECT_ID>";
}

- (NSString * _Nonnull)getProjectNumber {
    return @"<YOUR_PROJECT_NUMBER>";
}

@end
Deprecated Method - Swift
import AcessoBio

class YourUnicoConfigClass: AcessoBioConfigDataSource {
        
    func getProjectNumber() -> String {
        return "<YOUR_PROJECT_NUMBER>"
    }
    
    func getProjectId() -> String {
        return "<YOUR_PROJECT_ID>"
    }
    
    func getMobileSdkAppId() -> String {
        return "<YOUR_MOBILE_SDK_APP_ID>"
    }
    
    func getBundleIdentifier() -> String {
        eturn "<YOUR_MOBILE_BUNDLE_IDENTIFIER>"
    }
    
    func getHostInfo() -> String {
        return "<YOUR_HOST_INFO>"
    }
    
    func getHostKey() -> String {
        return "<YOUR_HOST_KEY>"
    }
}

Done. After completing the SDK installation, proceed to the implementation by reading the following material: Usage and Integration Guide:


Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

Last updated

Was this helpful?