This guide provides step-by-step instructions on integrating the IDV DocumentReader into an iOS application.
Before integrating the SDK, ensure the following:
- The application Minimum Deployment Target is iOS 14 and above.
- Camera permission enabled
- Optional: The Near Field Communication Tag Reading capability is enabled in the application target.
Add the base dependency into your Podfile:
target 'YourAppTarget' do
use_frameworks!
pod 'IDVDocumentReader'
end
Include the DocumentReader Core dependency, e.g.:
pod 'DocumentReaderFullAuthRFID'
Then install it:
pod install
Swift Package Collection is a set of all Regula products in one place.
To add Regula Swift Package Collection to your project, run the following command in Terminal:
swift package-collection add https://pods-master.regulaforensics.com/SPM/PodsCollection-signed.json
or in Xcode:
-
Navigate to File > Add Package Dependencies.
-
In the prompt that appears, click plus.
-
Select Add Package Collection.
-
In the prompt that appears, enter the collection URL:
https://pods.regulaforensics.com/SPM/PodsCollection-signed.json
-
Click Load and then Add Collection.
-
Select the package you want to add.
-
Select the version you want to use. For new projects, we recommend using the newest version.
-
Select the project you want to add the package.
-
Click Add Package.
Once you're finished, Xcode will begin downloading and resolving dependencies.
You can add each package individually instead of using the collection. To do so, follow these steps:
-
In Xcode, naviate to File > Add Package Dependencies.
-
In the prompt that appears, enter the API package URL:
https://github.com/regulaforensics/IDVDocumentReader-Swift-Package
-
Select the version you want to use. For new projects, we recommend using the newest version.
-
Select the project you want to add the package.
-
Click Add Package.
Once you're finished, Xcode will begin downloading and resolving dependencies.
- Add regula.license file to the app target. Setting is for IDVDocumentReader dependency
- Add db.dat file to the app target to use local database
- Set the description for NSCameraUsageDescription setting.
Optional: 2. Set NFC settings:
<key>com.apple.developer.nfc.readersession.felica.systemcodes</key>
<array>
<string>12FC</string>
</array>
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
<string>A0000002471001</string>
<string>E80704007F00070302</string>
<string>A000000167455349474E</string>
<string>A0000002480100</string>
<string>A0000002480200</string>
<string>A0000002480300</string>
<string>A00000045645444C2D3031</string>
</array>
For further details, refer to the official Regula IDVDocumentReader documentation or contact their support team.