Aadhaar API refers to the Authority Portal of India – which is a Developer Portal of UIDAI. This is targeted to a Developer Community who are having interest in developing/building Aadhaar enabled Applications. So here is a small and brief tutorial section for all the developers who want to build Applications using C/C++.
Developers can even have a look at the Sample Clients, UIDAI Certificate Details, License keys or any API Error Handling etc in this article. Each and every section such as Tutorial and Data Download section are included in this article to get a clear idea of Aadhar API.
Running Sample Application:
For the Developers to build Applications which use Aadhaar authentication, UIDAI has created a full end working sample of the JAVA Client Application just to help the Developers Community. The whole application will be written in JAVA which also demonstrates the included features of the Aadhaar Authentication.
- The Sample Client Application is provided on an “AS-IS” basis.
- This application should not be considered as a production strength software.
This Chapter covers the whole details of Downloading, Installing, Running and developing an environment only with the Source code. You can download the zip files of both Binary and Source Code to test the Aadhaar authentication from the official UIDAI API website which is mentioned below.
For More Details, Visit this link – https://authportal.uidai.gov.in/developer.
Aadhar API Developing Using Sample Applications:
In this chapter, you will be shown how to set up a Developing Environment with the help of the Binary and Source Code Zip Files. Developing an environment is helpful to test or to even build the Application which is enabled with Aadhaar Authentication.
All the steps and directions to set up the client as the Development Environment will be found in the official website created by the UIDAI. The link is also given below for the developers to view the page and the Sample Applications. But the steps are given for Windows OS and if you are using other OS or LINUX you should make appropriate modifications.
For the steps & instructions, Visit this link – https://authportal.uidai.gov.in/developer.
Aadhar API Developing in C/C++:
For the Developers who are interested in Developing Applications using the C/C++ are also provided with the Sample C Client Source code which can be able to help the Community to rapidly develop the Applications that uses Aadhaar API Authentication.
This Sample C Application is written by the GeoAmida Device which also demonstrates the various features of the Aadhaar Authentication. As said earlier, the Application is provided on the “AS-IS” basis and it covers the details about Downloading and Setting up the Environment only.
In here, you can find a Sample Authentication Software which works with an Aadhaar Authentication API. This Sample Software has the capability of Authenticating Demographic Fields, One Time Passwords (OTP), and also provides a provision for you to plug-in to the Biometric Captures.
This Software is written in Java and requires Java 1.6 source code along with the Maven Build Files and Eclipse Project Files are provided to the Developer Community.
UIDAI Certificate Details:
UDIAI 2048-Public Key is used to encrypt the AES-256 Session Key. In General, the Aadhaar Authentication requires the Identity of the data of the resident within the XML(PID Block). This page contains all the details and all the certificates available for the ecosystem.
All the Production Certificates are available in here, https://authportal.uidai.gov.in/developer.
Testing Data & License Keys:
If you want to make use of your own UIDs for testing services like e-KYC, you can always request for creation of a test UID by sending a mail to email@example.com. The e-mail should be sent from your registered e-mail which is mandatory.
All the test UIDs and their demographic data are shown in the link here, https://authportal.uidai.gov.in/developer.
Aadhar API Error Handling:
The UIDAI provides guidelines through this page, which can be used to handle the API errors within the Application. AUAs have to decide on how to handle the errors while developing the Aadhaar enabled Applications.
They should handle those carefully and should provide the resident/operator friendly messages. This Document is an attempt to provide guidelines for efficient error handling.
For more information About Aadhaar API visit the Official URL link which we shared above.