iOS
This is a walkthrough of how you can integrate the Onboarding or Authenticate SDK for iOS applications.
Last updated
This is a walkthrough of how you can integrate the Onboarding or Authenticate SDK for iOS applications.
Last updated
Latest version:
In order to perform an Onboarding or an Authenticate, you should follow those steps:
: install and import the SDK
: request a token using your business credentials
: launch a user workflow
: use the Message handler to get insights about the user workflow
: use your callback or the endpoint to get the analysis result
The proper functioning of the SDK necessitates the provision of several parameters. These parameters are essential for enabling the full range of functionalities offered by the SDK.
iOS 15+ (because of Swift minimum version)
Available for iPhone and iPad in portrait mode only
Mandatory app permission
The SDK uses the device's camera functionality.
You must add NSCameraUsageDescription
within your application's Info.plist
file (see ).
To securely manage your credentials, you’ll need to create a .netrc
file in your home directory with the necessary login details.
Create and open
Type touch ~/.netrc & open ~/.netrc
Add login details
Set file permissions
chmod 600 ~/.netrc
To install the SDK with CocoaPods, you'll need to add the dependency to your Podfile
. (if it doesn't exist, create one by running the following command in your project directory: pod init
)
Add the following to your target
Run pod install
to install the dependency
Now, you can import and use the SDK in your project
Use the credentials you received from ShareID's team to get an authentication token and launch an onboarding or authenticate workflow.
Once you have added the SDK as a dependency and have your credentials, you can configure the SDK.
The service
specifies the service in the SDK:
onboarding
starts the onboarding process
authenticate
starts the authenticate process
To receive feedback from the SDK, you need to implement the messageHandler
closure, which manages various responses from the ShareID process.
This closure is triggered when the ShareID SDK completes an operation, fails, or encounters an error.
When the processing of an onboarding or authenticate request is finished, you may receive the result through the callback if you provided it. You may also, fetch yourself the result by calling our API.
The ShareID iOS SDK is built to be highly customisable, allowing for flexibility through various configuration options or by applying themes to adapt the user interface to your needs.
Languages supported:
🇸🇦 (ar), 🇩🇪 (de), 🇬🇧 (en), 🇪🇸 (es), 🇫🇷 (fr), 🇮🇹 (it), 🇵🇱 (pl), 🇵🇹 (pt), 🇷🇴 (ro), 🇷🇺 (ru)
Be sure to add CFBundleLocalizations
to your Info.plist
file with all the languages you want to support in your application. (This ensures that default Apple buttons are properly localised and enables RTL navigation)
ShareID supports with authenticate handled via a .netrc
file.
Depending on the SDK you are integrating (Onboarding/Authenticate), you may use an API here
To view all possible end-of-process results in our SDK, please refer to the for all success, exit and failure states.
See for more details.