Skip to main content
Version: 1.0.0 - 1.5.x

Installation

This guide covers how to install and set up the DocIDV iOS SDK in your project.

Integrate DocIDV SDK​

Follow these steps to integrate the DocIDV library into your application.

Import SDK​

The DocIDV SDK is available exclusively through Swift Package Manager (SPM).

  1. Copy the official SPM repository URL: https://github.com/idnow/docidv-sdk-ios
  2. In Xcode, navigate to File > Add Package Dependencies... and paste the URL.
  3. Choose the desired package version. We recommend selecting "Up to Next Major Version" to receive compatible updates automatically. Click Add Package.
  4. Add one of the two Package Products to your application's target: DocIDV or DocIDV-without-XS2A.
  5. Click Add Package.

📥 DocIDV is now imported into your project. Note that Xcode has also imported several other libraries that our SDK depends on. You will find them in the Package Dependencies list in the Project Navigator.

Configure Your App​

To use our SDK, you need to configure your project to allow the use of the camera and NFC.

Entitlements File​

  1. Open your entitlements file (If you don't already have one, File > New File > Property List, and name it, e.g., YourApp.entitlements).
  2. Add a new key Near Field Communication Tag Reader Session Formats of type Array.
  3. In this array, add an item:
    • key: Item 0 (Near Field Communication Tag Reading Session Format)
    • value: Tag-Specific Data Protocol (TAG)

Info.plist File​

  1. Open your main Info.plist file.
  2. Add a new key ISO7816 application identifiers for NFC Tag Reader Session of type Array.
  3. Add the following two strings to this array:
    • A00000045645444C2D3031
    • A0000002471001
  4. Add an entry for Privacy - NFC Scan Usage Description that describes why your app needs to use NFC.
  5. Add an entry for Privacy - Camera Usage Description that describes why your app needs to use the camera.
  6. Add an entry for Privacy - Photo Library Usage Description that describes why your app needs to store photos on the device.
  7. If you use the video call feature, please add Privacy - Microphone Usage Description that describes the use of the microphone for calls with an agent.

👏 You are now ready to integrate the DocIDV SDK.

Support​

If you encounter installation issues:

  1. Search GitHub Issues
  2. Contact IDnow Support