The OneSpan Sign iOS SDK is a feature that enables users to run e-signature processes from mobile devices that use iOS 10 and higher.

This SDK employs a server-client model, with a OneSpan Sign product as "server" and a company's mobile application as "client". The server can be either a SaaS product (e.g., OneSpan Sign Professional) or an on-premises product (e.g., OneSpan Sign).

Because of this server-client model, this feature won't work until both of the following have been configured:

For any issues see Troubleshooting iOS SDKs

Strictly speaking, the OneSpan Sign iOS SDK is only on the client side. The role of the server side is to provide support for the OneSpan Sign iOS SDK.

Downloading the iOS SDK

To download the iOS SDK click here.

To view Release Notes for the OneSpan Sign iOS SDK, click here.

Signing on mobile devices via the OneSpan Sign iOS SDK will not work unless supporting server-side software has been provided. That server-side software becomes available as soon as you create your SaaS account.

This section discusses:

Client-Side Packaging

Each release of the OneSpan Sign iOS SDK has an eSignLiveSDK_iOS directory, which in turn has the following main sub-directories:

  1. Sample: Contains a sample project that provides a detailed demonstration of the following SDK functionalities:
  • Login (with email and password)

  • Start/Edit Transaction
  • Prepare New Transaction

  1. Frameworks: Contains the following sub-folders:
  • Debug-universal: Contains a Debug Framework for the following architectures: arm7, arm7s, arm64, i386 and x86_64 (for both Device and Simulator)

  • Release-iphoneos: Contains a Release Framework for the following ARM architectures: arm7, arm7s, and arm64
  1. SDKAssets: Contains the following sub-folders:
  • Fonts: Contains the font files to be added to the project target and to the file info.plist.

  • Images: Contains SDK-used images in an asset file. Any image can be replaced by another if it has the same name and resolution.
  • UIElements: Contains storyboard files and NIB files, both of which are used to build a User Interface. These files can be edited as needed.
  • The above SDK Assets are not compiled with the SDK, but are linked via the end-developer application. End-developers may customize these assets to suit their needs.

Integrating the OneSpan Sign iOS SDK

This section discusses:

The Sample project has already been integrated with the Debug Framework. Please integrate the Release Framework before submitting your application to the App Store.

Integrating the OneSpan Sign iOS SDK Framework into an Existing Project

  1. Open your project in Xcode, and select it from the Project Navigator.
  2. Select the appropriate target from the TARGETS panel, and click the General tab.
  3. Scroll down to Embedded Binaries.

  4. Drag and drop the Framework file called eSignLiveSDK.framework into Embedded Binaries.

  5. In the dialog box that appears, select Copy items if needed.

  6. Click Finish.
  7. The Framework file eSignLiveSDK.framework will be added to:

  • Embedded Binaries
  • Linked Frameworks and Libraries
  • Project Navigator
  • Click the Build Settings tab, and set Always Embed Swift Standard Libraries = YES.

  • In the previous version of Xcode, this flag was called EMBEDDED_CONTENT_CONTAINS_SWIFT.
  • Drag the SDKAssets folder from the eSignLiveSDK_iOS directory, and drop it into the Project Navigator.
  • In the dialog box that appears, select Copy items if needed and Add to targets.
  • Click Finish.
  • To properly configure the file info.plist:
    1. Open the file info.plist.
    2. If it is not already there, add the property Fonts provided by application. This property is called UIAppFonts in raw format.
    3. Add an item for each font you want to support.
    4. Add the following font values: Ubuntu-Bold.ttf, Ubuntu-Italic.ttf, Ubuntu-Regular.ttf, Ubuntu-Light.ttf.
    5. If it is not already there, add the property Privacy - Contacts Usage Description., and type a description of how the application will use its Contacts data. This property is called NSContactsUsageDescription in raw format.
    6. Save and close the file info.plist.
    1. Ensure that the "code signing" properties are configured correctly.
    2. Clean, build and run your project.
    3. There should be no Compiler or Linker errors at this stage.

    Non-Native iOS Applications

    Non-native applications (built over third-party implementations) can integrate the OneSpan Sign Mobile SDK into their application. However, hooks to the SDK must be added through delegate Callbacks of UIWebview or UIWebKit. A navigation controller reference must be provided for push stack.

    Using Interfaces

    The Headers sub-directory of eSignLiveSDK.framework includes the following interfaces:

    • eSignLiveSDK.h — The umbrella header
    • OneSpan Sign.h — Most integration work involves this interface.
    • ESTransaction.h — A representation of a Transaction interface object
    • ESDocument.h — A representation of a Document interface object
    • ESFormfield.h — A representation of a Form Field interface object
    • ESSigner.h — A representation of a Signer interface object

    Detailed documentation of each interface is in the file that bears its name.

    To see how these interfaces are used:

    1. Go to the Sample project provided by OneSpan Sign.
    2. Open the file ViewController.m, which contains code snippets for the most important SDK features.
    3. Explore those code snippets, as well as the following Code Examples.