Sample Clients

Authentication Sample Client (Java) kk

This is a sample authentication client software which works with authentication API. This software has the capability to authenticate demographic fiels, OTP,and provision to plug-in biometric capture. This is written in Java and requires Java 1.6. Source code along with Maven build files and Eclipse project files are also provided.

This is designed purely as a test tool to reduce the development time taken by the AUAs and device vendors. This is released as source code and developers are free to download, modify, enhance, and use it. THIS IS NOT A SUPPORTED SOFTWARE.

---------------------------------------------------------------------------------------------
User manual - See "Aadhaar e-KYC Basics" book.
----------------------------------------------------------------------------------------------

e-KYC API version 1.0 Sample Client - Full Source Code - updated 08 Jan 2014

e-KYC API version 1.0 Sample Client - Full Binary - updated 08 Jan 2014 (NOTE: Also download Fop and Batik and extract the jar files to "jar" directory for printing to work)

e-KYC API version 2.0 Sample Client - Full Source Code - updated 22nd Sep 2016

e-KYC API version 2.0 Sample Client - Full Binary - updated 22nd Sep 2016

Schema Files for Various APIs

XSD and Protobuf files for Aadhaar Authentication APIs Version 1.6

Authentication Clients and Samples in other Languages

Authenticaion client written in C/C++ is made available to the community by Geodesic team for their GeoAmida device. Full source is hosted at their Github repository. Please note that this software is neither created nor maintained by UIDAI. Aadhaar community is thankful to Geodesic for contributing this as open source to the community.

Authenticaion client written in Python and related tools are made available to the community by Venkata Pingali from TCS Labs, Pune. Full source is hosted at this Github repository. In addition, Aadhaar-based login module for Django is available here. Please note that this software is neither created nor maintained by UIDAI. Aadhaar community is thankful to the author for contributing this as open source to the community.

Authentication Tools

Biometric data formats (FMR, FIR, IIR) testing tool checks if formats are valid ISO formats and as supported by Aadhaar Authentication. Developers can use this tool to test if the biometric record is proper before testing it online.

Biometric Format Test Tool - Binary and Source - Released on 9 Aug 2012

Bulk demographic authentication tool facilitates Demo Auth, accepting demographic data of the residents through various input modalities. THIS IS A SAMPLE TOOL demonstrating the features of demographic authentication. Both source and binary are provided below.

Binary setup and user manual - Binary - Released on 9 Oct 2013

Source code project - Source - Released on 9 Oct 2013

KYR+ Sample Application (NEW VERSION)

This is a sample reference implementation of KYR+ software which works with Aadhaar Enrolment Client 1.2.x versions. This software has the capability to configure fields and capture additional fields specific to registrars. This is built using Visual Studio 2008 using Windows forms and C#.

This is designed purely as a productivity tool to reduce the development time taken by the registrars on the KYR+ aspect. This is released as source code and registrars are free to download, modify, enhance, and use it. THIS IS NOT A SUPPORTED SOFTWARE.

KYR+ sample application (New Version) - Full source code - released 15 March, 2011.

KYR+ sample application (New Version) - Binary - released 15 March, 2011.

KYR+ sample application document (New Version) - User Manual - released 15 March, 2011

Decryption Test Utility (1024-bit)

This test decryptor utility is developed to assist Registrars in decrypting the Registrar Enrolment Packets before go-live. This utility works with packets that are encrypted with 1024-bit key (see below for 2048-bit key tool)This utility supports only PFX and PEM formats for private key files. The private key files must be password protected. This tool also supports USB Token with .Net PKCS11 APIs at location "C:\WINDOWS\system32\aetpkss1.dll".

For all the other cases, a modification in the source code of Decryptor Utility is necessary for execution the decryption. Full source code is available below for download.

This is designed purely as a test tool along with source code provided for initial testing. THIS IS NOT A SUPPORTED SOFTWARE.

Decryption utility binary - last updated 16 Nov, 2010. 

Decryption utility source code - last updated 16 Nov, 2010.

Decryption utility "read me" document - last updated 16 Nov, 2010

Decryption Test Utility (2048-bit key)

This test decryptor utility is developed to assist Registrars in decrypting the Registrar Enrolment Packets before go-live. This utility works with packets that are encrypted with 2048-bit key (see above for 1024-bit key tool). This utility supports only PFX and PEM formats for private key files. The private key files must be password protected. This tool also supports USB Token with .Net PKCS11 APIs at location "C:\WINDOWS\system32\aetpkss1.dll".

For all the other cases, a modification in the source code of Decryptor Utility is necessary for execution the decryption. Full source code is available below for download.

This is designed purely as a test tool along with source code provided for initial testing. THIS IS NOT A SUPPORTED SOFTWARE.

Decryption utility binary - last updated 31 Oct, 2011. 

Decryption utility source code - last updated 31 Oct, 2011.

Decryption utility "read me" document - last updated 31 Oct, 2011.

KYR+ Sample Application

(OLD VERSION, see below for new version links) This is a sample reference implementation of KYR+ software which works with Aadhaar Enrolment Client 1.1.x versions. This software has the capability to configure fields and capture additional fields specific to registrars. This software saves the captured data into an embedded database. This is built using Visual Studio 2008 using Windows forms and C#.

This is designed purely as a productivity tool to reduce the development time taken by the registrars on the KYR+ aspect. This is released as source code and registrars are free to download, modify, enhance, and use it. THIS IS NOT A SUPPORTED SOFTWARE.

KYR+ sample application (Old Version) - Full source code for version 3.0 - released 15 Sept, 2010.

KYR+ sample application document (Old Version) - Version 3.0 documentation - released 15 Sept, 2010

FI - Bank Response XML Encryption Certificate

The below certificate should be used for encrypting the response XML before placing them in SFTP INBOX of UIDAI.