Skip to main content
This guide explains how to integrate the UAEKYC Framework into your iOS project. The framework is distributed as an .xcframework bundle, which provides compatibility across different architectures and platforms.

​
Prerequisites

Ensure you have acquired CDN account credentials, along with the repository URL (this will be communicated via official channels).

​
Step-by-Step Instructions

​
Step 1: Download and extract .xcframework

Open the CDN link in browser for the latest version and download the UAEKYCFramework.xcframework.zip file and extract it.

​
Step 2: Open Your Xcode Project

  1. Launch Xcode.
  2. Open the project where you want to integrate the UAEKYCFramework.
  3. Create a Frameworks group if it does not exist by right-clicking in the Project Navigator on your project name.

​
Step 3. Add the .xcframework to Your Project in Xcode

  1. Drag and drop the .xcframework file into your project’s Frameworks group in Project Navigator (on the left-hand side).
  2. In the dialog that appears:
    • Select the appropriate targets where the framework will be used.
    • Ensure the “Copy items if needed” checkbox is checked to copy the framework into your project.
  1. Go to your project settings by clicking on the project name in the Project Navigator.
  2. Select your app target under the Targets section.
  3. Go to the General tab.
  4. Scroll down to the Frameworks, Libraries, and Embedded Content section.
  5. Click the + button and add your .xcframework to the list.
  6. Set the Embed option to Embed & Sign.

​
Step 5: Add NFC Tag Reading Capability

The SDK uses NFC to read Emirates ID and Passport data. You need to configure the NFC capability and entitlements.

​
5.1 Add NFC Capability

  1. Go to your project settings by clicking on the project name in the Project Navigator.
  2. Select your app target under the Targets section.
  3. Go to the Signing & Capabilities tab.
  4. Click the + Capability button.
  5. Search for and add Near Field Communication Tag Reading.

​
5.2 Configure Entitlements

After adding the capability, Xcode will create an entitlements file (or update an existing one). Ensure it contains: 
<key>com.apple.developer.nfc.readersession.formats</key>
<array>
    <string>TAG</string>
</array>

​
5.3 Add Privacy Usage Description

Add the following key to your Info.plist to describe why your app needs NFC access:
KeyTypeValue
NFCReaderUsageDescriptionStringA description explaining NFC usage (e.g., “Required to read Emirates ID or Passport”)
Or add it directly in XML format: 
<key>NFCReaderUsageDescription</key>
<string>Required to read Emirates ID or Passport</string>

​
Step 6: Verify the Integration

  1. Confirm the UAEKYCFramework module is accessible in your project by importing it: 
    import UAEKYCFramework
  2. Build your project to ensure the package is correctly integrated.

​
Troubleshooting

  • URL Errors: Verify the repository URL is correct and accessible.