Tap2iD VDS for Windows - Integration
Install the Credence ID VDS on Windows 10 or 11 and validate the service to ensure your system is ready for hardware communication.
vds-webapp on GitHubPrerequisites
Have these ready before running the VDS installer:
- Tap2iD device connected to your Windows 10/11 PC via USB
- Windows 10/11 PC: Administrator account access required
- VDS installer: Download VDS Installer
Steps to Install VDS Only
Install the VDS service on your Windows machine:
Download and unzip the installer
Download the VDS Installer and unzip it to a local folder.
Run the installer as Administrator
Navigate to the CredenceID_VDS_Installer_v3.2.2 folder, right-click CredenceID_VDS_Installer_v3.2.2 and select Run as Administrator.
Bypass Windows SmartScreen
If Windows Defender SmartScreen appears, click More Info then Run anyway.
Approve User Account Control
Click Yes on the User Account Control (UAC) prompt to allow the installation to proceed.
Validate the VDS Service
After installation and restart, confirm the VDS service is running correctly.
C:\Program Files\CredenceIDOpen Windows Services
Press Win + R, type services.msc, and press Enter.
Search for CredenceID_VDS_Service
Locate CredenceID_VDS_Service in the list. Its status should show Running.
Stop, Pause, or Restart the service
Use the options on the left panel of the Services window to manage the VDS service lifecycle.
Configuration & Logs
Important file locations and default settings for the VDS service.
-
Logs are generated under
C:\Program Files\CredenceID\logs -
Config file:
C:\Program Files\CredenceID\app\config\application.properties - Any config change requires a service restart
-
VDS Server default port number:
4215 -
WinUSB Driver installer logs:
C:\Users\<profile>\Documents\Credence_WinUSB_log
Navigate to C:\Program Files\CredenceID\app\config and open application.properties as Administrator. Update the following parameter:
server.port=4215
Save the file and restart the VDS service for the change to take effect.
In application.properties, update the following parameter:
server.ssl.enabled=false
Save the file and restart the VDS service.
In application.properties, update the following parameters to point to your external keystore:
server.ssl.key-store=file:C://certs//external_keystore.p12
server.ssl.key-store-type=PKCS12
server.ssl.key-alias=localhost
The keystore password is read from Windows Credential Manager. Since VDS runs as a Windows Service under the Local System account, the keystore password must be stored using that account. Follow these steps:
Download PsTools
Download PsTools from the official Microsoft Sysinternals page.
Open Command Prompt as Administrator
Navigate to the folder where PsTools was downloaded and open Command Prompt in Administrator mode.
Run the PsExec command
Execute the following command to store the keystore password:
PsExec.exe -s /accepteula cmdkey /generic:CredenceID_VDS_Credential /user:vds /pass:<external_keystore_password>
Sample Check-in WebApp
The VDS Check-in WebApp is a Node.js and React sample that shows how to use Tap2iD verification in a check-in flow. Use it as a reference implementation. Source on GitHub →
Health Check
Verify VDS is running before setting up the WebApp. Send a GET request from Postman or any API testing tool:
https://localhost:4215/verifier-sdk/reader/info
Prerequisites
- Modern web browser: Chrome, Edge, or Firefox.
- IDE: VS Code or another of your choice.
- Node.js and NPM: download from nodejs.org.
Setup
Clone the repository:
git clone https://github.com/CredenceID/vds-webapp.git
Install dependencies and build the frontend:
cd vds-frontend
npm install
npm run build
cd ../vds-backend
npm install
Run the WebApp
Start the backend server:
cd vds-backend
node index.js
Open http://localhost:3000 in your browser. The WebApp is now running. Make sure Tap2iD and VDS are connected for full functionality.
Customize the WebApp
To replace the logo, place your image in vds-frontend/src/assets/images/ and update the src attribute on the img tag.
To customize text on each page:
- Home page:
vds-frontend/src/containers/dashboard/dashboard.jsx - Check-in page:
vds-frontend/src/components/informationModal/InformationModal.jsx - Settings page:
vds-frontend/src/containers/settings/Settings.jsx
After any change, rebuild the frontend (npm run build) and restart the backend.
Run Without Hardware (Mockoon)
If Tap2iD and VDS aren't available, mock the VDS APIs using Mockoon. Edit UrlConfig.js and change "https" to "http" in the VDS_URL, then rebuild the frontend and restart the backend. Use the VDS Interface Control Document for request and response formats.
Known Installer Issues & Workarounds
VDS Installation Issue: PsTools Blacklisted by Anti-Virus
The VDS installer uses PsTools to store the SSL keystore password into Windows Credential Manager using the Local System account. If the system anti-virus has blacklisted PsExec, the installation will fail.
C:\Users\<user>\AppData\Local\Temp\CredenceID\installable
Steps to Uninstall VDS
Open Add or Remove Programs
Go to System Settings โ Apps โ Add or Remove Programs.
Select CredenceID_VDS
Find and select the app named CredenceID_VDS in the list.
Uninstall the app
Click Uninstall and follow the prompts to complete removal.
Upgrade Procedure
- VDS only installer supports in-place upgrade. Run the new installer.
- VDS + Form Fill installer does not support upgrade yet. As a workaround, go to Add or Remove Programs and manually uninstall both VDS and Form Fill separately before running the new installer version.