Skip to main content

Installation

Importing the FaceCamera SDK into your project

The SDK package contains a folder called SDK and a subfolder called FaceCamera.xcframework, which includes all of the supported architectures as xcframeworks.

  1. Select the appropriate SDK and copy it into your project directory.
  2. Import FaceCamera.xcframework into your Xcode project.
  3. Make sure that it is listed as Embed & Sign under your target settings.

Importing additional dependencies

The FaceCamera requires some additional dependencies to perform certain operations (IDLiveFaceCamera.xcframework and IDLiveFaceIAD.xcframework), which are responsible for camera liveness logic. These dependencies are no longer included inside the Face package and are now provided separately in the IDLiveSDK Dependencies package.

  1. Download the required IDLiveSDK dependencies package.
  2. Drag each of the included .xcframework dependencies into the root level in your Xcode project.
    1. Select Copy files to destination.
    2. Ensure your main project is targeted.
  3. Make sure they are listed as Embed & Sign under your target settings.

Adding the module

Within your app add the following:

import FaceCamera

Updating

To update, you should download the new package and reimport it into your project.

Note: There may be breaking changes or feature updates, you should still review the migration details and the integration details for the version you are updating to and may need to make code changes. This section simply talks about how to update the installed version.

Troubleshooting

The above is all that is needed to install the SDK in most cases. The following discusses some less likely situations:

SPM (Swift Package Manager) support

We are aiming to distribute through SPM at some point in the future, but do not have a planned date yet.