Tap2iD SDK for Windows - Integration
Get started by integrating the Tap2iD SDK into your project. Use NuGet to fetch the necessary packages from the Credence ID Nexus repository.
Tap2iD-SDK-Windows on GitHubPrerequisites
Recommended Bluetooth Hardware
Use a USB Bluetooth dongle. Tested models:
Two ways to get started
Pick whichever fits your goal: try the bundled sample to see Tap2iD in action, or skip straight to adding the SDK to your own project.
Try the sample app
Run the Windows SDK installer to set up the bundled Tap2iDSampleWinUI app, drivers, and runtime. Skip this section if you only want to add the SDK to your own project.
Connect your Bluetooth dongle
Plug in the Mini BT540 or Mini BT542 before starting the installer so Windows recognises the adapter.
Download the installer
Launch the installer
Double-click the file to start setup. Click More info → Run anyway → Yes. Keep the default install path, click Next, then Install. Wait for the bundled Python installation to finish.
Select your Bluetooth device
When prompted, choose the adapter to use for mDL transactions. Enter 1 and press Enter.
Complete installation
The installer sets up Tap2IDSample and the required drivers. The application launches automatically when finished. If it does not open, search for Tap2iDSampleWinUI in the Start menu and launch it from there.
C:\Program Files (x86)\Tap2IdWinSDKInstaller\Tap2ID.log.Development environment
Your development environment must meet these requirements:
- VS Visual Studio 2022: When launching for the first time, install the Windows App SDK workload.
- 🔧 Minimum Framework: .NET 8.0
- 🖥 Minimum OS Version: Windows 11
- 📶 Active internet connection: The network must not be restricted by a firewall that could block downloads or installation.
Add Tap2iD to your project
Configure the Credence ID NuGet package source in Visual Studio, install the Tap2iDSdk package, and initialize the SDK with your license key.
Configure Nexus Repository in Visual Studio
Open a Windows application in Visual Studio (or create one) and add the Credence ID NuGet package source.
Open NuGet Package Manager
Right-click on your project in the Solution Explorer and select "Manage NuGet Packages…"
Open Package Source Settings
In the NuGet Package Manager, click the Settings (⚙) gear icon in the top-right corner.
Add the Credence ID Package Source
Click the "+" button and add the following URL. Keep NuGet.org and Microsoft Visual Studio Offline packages selected too.
https://nexus.credenceid.com/repository/tap2id-sdk-nuget/Select "All" as Package Source
In the NuGet Package Manager dropdown, select "All" so all sources are searched.
Add the Tap2iD SDK Dependency
With the package source set up, search for and install the Tap2iDSdk package.
Search and Install
In the NuGet Package Manager Browse tab, search for "Tap2iDSdk" and click "Install".
Apply Changes
Review the list of changes in the preview window and click "Apply" to confirm installation.
Accept License
When prompted with the license agreement dialog, click "I Accept" to proceed.
Installation Complete
Wait for the installation to finish. The output window confirms when the package is installed.
Installed packages
After installation, verify these packages appear in your project's references:
Add your license key
Generate your license key on the Tap2iD SDK License Key page, then pass it when you initialize the SDK. Do not hard-code the key. Store it in appsettings.json or a secrets manager.
var config = new CoreSdkConfig
{
ApiKey = "YOUR_API_KEY", // from verify.credenceid.com
Transport = TransportType.BLE
};
Tap2iDSdk.InitSdk(config, new InitSdkResultListener
{
OnSuccess = () => { /* ready */ },
OnError = err => { /* handle */ }
});appsettings.json or Windows Credential Manager. Do not commit it to source control.