Skip to main content

Quick start

Veriph.One offers a swift solution for adding phone verification to any mobile application. This guide will walk you through the process of integrating Veriph.One, initiating a verification, and retrieving a result in your app using our SDK, thereby enhancing the security and reliability of your platform.

Before diving into the integration process, let's ensure you're well-prepared. Here's what you should have:

  1. You have a working iOS app project you want to integrate.
  2. You have read our Introduction article that explains how the integration works.
  3. You already have a Veriph.One account and have obtained API Keys for your mobile environments; see how to do so here.
  4. Your server or backend has the Start and Result Endpoints ready for use by your app. Follow this guide if you need to complete this step.
  5. (Optional) You visited our demo app to see what our SDK can help you accomplish.

Technical considerations​

We built our iOS SDK with a balance between backward compatibility and modern APIs in mind; as such:

  1. It's a native SDK that most platforms should support, even non-native ones. If you find that inaccurate, please let us know, and we'll help you integrate it into your stack. 
  2. It was built using Swift + SwiftUI and on top of the latest best practices in the industry.
  3. The minimum deployment target is iOS 15.0, which should cover over 99% of active devices for maximum compatibility.
  4. Requires no special permissions.
  5. It was designed to be as lightweight and performant as possible, allowing the developer the best experience attainable. Still, we make continuous efforts to push our limits in this regard.

Installation​

Veriph.One distributes its iOS SDK through Swift Package Manager. To install the package, follow the steps listed below:

  1. In your XCode project go to Targets, select your target and search for Frameworks, Libraries and Embedded Content in the General tab.
  2. Press the '+' button, click Add other and then Add Package Dependency.
  3. Enter the package URL https://github.com/Veriph-One/veriph-one-sdk-ios in the search field.
  4. Once it loads, select your dependency rule and click on the Add Package button. Please refer to the package's URL for detailed information about available versions, including the latest release.
  5. In case a confirmation prompt appears, click on the Add Package button again.

API Keys​

Our SDK requires an iOS or Generic Mobile API Key to operate; however, these values should never be committed to a code repository. Doing so would expose your company to security leaks and vulnerabilities. For this reason, we recommend you leverage a Config file that you include in your git.ignore.