Close Menu

ppblinkid

Welcome to the documentation page for ppbLinkID, a library that provides a simple and convenient way to integrate BlinkID SDK into your iOS application. This library allows you to easily scan various types of identification documents such as ID cards, passports, and driver’s licenses.

Getting Started

Before you start integrating ppbLinkID into your iOS project, make sure you have the following prerequisites:

  • Xcode IDE installed on your machine
  • An active Apple Developer account

Follow these steps to integrate ppbLinkID into your iOS application:

  1. Download the latest version of ppbLinkID from the BlinkID GitHub repository.
  2. Unzip the downloaded file and navigate to the “BlinkID_XYZ” directory.
  3. Open your Xcode project.
  4. In the Finder, drag and drop the “BlinkID_XYZ” directory into your Xcode project.
  5. In the dialog that appears, make sure to select “Copy items if needed” and check the target to which you want to add BlinkID.
  6. In your Xcode project’s target settings, navigate to the “Info” tab and under “URL Types” section, add a new URL scheme. The URL scheme is in the format “blinkidXYZ” and it corresponds to “XYZ” part in the “BlinkID_XYZ” folder name.
  7. In your app’s Info.plist file, add the following key-value pair:
    • Key: Privacy – Camera Usage Description
    • Value: $(PRODUCT_NAME) needs camera access to scan identification documents.
  8. Build and run your project. ppbLinkID is now integrated into your iOS application!

Usage

Using ppbLinkID is straightforward. Simply follow the steps below to get started:

  1. Import the ppbLinkID module in your Swift file:
import ppbLinkID
  1. Create an instance of BlinkIDCombinedRecognizer:
let blinkIDCombinedRecognizer = BlinkIDCombinedRecognizer()
  1. Implement the BlinkIDViewControllerDelegate protocol in your view controller:
class MyViewController: UIViewController, BlinkIDViewControllerDelegate {
    // Your code here
}
  1. Show the BlinkIDScanViewController to allow users to scan their identification documents:
func showBlinkIDScanView() {
    let blinkIDScanViewController = BlinkIDScanViewController(recognizer: blinkIDCombinedRecognizer, delegate: self)
    present(blinkIDScanViewController, animated: true, completion: nil)
}
  1. Handle the scan results in the delegate method:
func blinkIDViewControllerDidFinishScanning(_ blinkIDViewController: BlinkIDScanViewController,
                                               state: MBScanViewResult) {
    if let result = state.result {
        // Handle scan results here
        print(result)
    }
}

Congratulations! You have successfully integrated ppbLinkID into your iOS application.

Additional Resources

For more details on how to customize the scanning process and manage scan results, please refer to the official BlinkID SDK documentation.