Aadhaar eSign Using Face Auth Setup Guide
Introduction
Signzy provides Aadhaar eSign by employing the signer's facial features as biometrics to authenticate identity and finalize the signing process. This involves utilizing the signer's face for verification during authentication.
The utilization of Aadhaar eSign with Face Authentication is exclusive to a native mobile application on a mobile device. This functionality is not supported on desktops/laptops through web-based workflows. Additionally, it will not operate on a mobile device when accessed via a web-based workflow.
As of now, Aadhaar eSign with Face Authentication is compatible exclusively with Android mobile devices. iOS, Windows, or any other operating systems on mobile devices do not currently support this feature.
If you require assistance in setting up the service or have any questions, please contact our helpdesk at [email protected] or reach out to your designated Customer Success Manager (CSM).
Setup Guide
Here is a step-by-step process to use Aadhaar based eSign using Face Auth.
Step 1 - Utilize the "Initiate Contract API" to create the contract. When employing the Aadhaar eSign Using Face Auth functionality, ensure to include "signatureType": "AADHAARESIGN-FACEAUTH" in the parameters.
Step 2 - Upon generation of the contract through the API, the output will include the Signer ID.
Step 3 - Invoke Signzy's Aadhaar eSign SDK by utilizing this Signer ID.
Signzy's Aadhaar eSign SDK Integration Steps
E-sign is a versatile and powerful software development kit designed specifically for Android applications. By seamlessly integrating eSignSDK, developers can enhance their apps with the ability to facilitate electronic contract signings, ensuring both security and convenience.
To integrate the Android archive(.aar) file in any android application following steps need to be followed:
Step 1
Copy the esignSDK-(env)-release.aar file to app/libs/
For testing in preproduction envrionment, use the esignSDK-PREPROD-release.aar
For production envrionment, use the esignSDK-production-release.aar
Links for both the files are provided below. You can download them.
You must install the FACE RD Mobile Application, provided by UIDAI, to capture facial data and perform face matching with UIDAI's records.
The FACE RD App for Preproduction can be downloaded from - https://drive.google.com/file/d/1pkkn1iTNSnTZWY1U8EAEPt7IP6LRPGuP/view?usp=sharing
If you are having issues while downloading this file, please get in touch with your CSM and they will provide you with the application.
The FACE RD App for Production can be downloaded from Google PlayStore - https://play.google.com/store/apps/details?id=in.gov.uidai.facerd&hl=en_IN&gl=US&pli=1
Step 2
In settings.gradle add the following to support jitpack.io
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
//Other deps
maven{ url 'https://jitpack.io' }
}
}
Step 3 - Import dependencies
In app level build.gradle add following dependencies
implementation(files("libs/esignSDK-(env).aar"))
Implementation "com.github.signzy:esign-sdk:1.0.0"
Implementation "androidx.databinding:viewbinding:8.2.1"
Implementation "com.squareup.retrofit2:retrofit:2.9.0"
Implementation "com.squareup.retrofit2:converter-gson:2.9.0"
Implementation "com.squareup.okhttp3:logging-interceptor:4.5.0"
Implementation "com.google.code.gson:gson:2.10.1"
Implementation "com.android.volley:volley:1.2.1"
Implementation "com.scottyab:rootbeer-lib:0.1.0"Step 4 - Invoke SDK
To invoke sdk we need to call the startActivityForResult function using SignzyEsignActivity
SDK needs to string params in input whose string constants are already there in SignzyEsignActivity
SIGNZY_SIGNER_ID : It is the signer ID which you get in Inititate Contract API
SIGNZY_CONTRACT_TOKEN: It is the same token which you use while using the OTS product
val appStartIntent = Intent(
this,
SignzyEsignActivity::class.java
).putExtra(SignzyEsignActivity.SIGNZY_SIGNER_ID, signerId)
.putExtra(SignzyEsignActivity.SIGNZY_CONTRACT_TOKEN, token)
startActivityForResult(appStartIntent, SignzyEsignActivity.SIGNZY_REQUEST_CODE)Step 5: Watch For Result
On activity result can be setup
String constants are available in SignzyEsignActivity as
SIGNZY_RESULT : this will give you the file URL of signed PDF
SIGNZY_ERROR_MESSAGE : this will give the error message
SIGNZY_ERROR_CODE : this will give the error code
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == SignzyEsignActivity.SIGNZY_REQUEST_CODE) {
if (resultCode == Activity.RESULT_OK) {
//this is the signed file URL
val file = data?.getStringExtra(SignzyEsignActivity.SIGNZY_RESULT)
Toast.makeText(this,file,Toast.LENGTH_LONG).show()
} else {
// Incase ACTIVITY_CANCELED {errMsg & errCode is available}
val errMsg = data?.getStringExtra(SignzyEsignActivity.SIGNZY_ERROR_MESSAGE)
val errCode = data?.getStringExtra(SignzyEsignActivity.SIGNZY_ERROR_CODE)
Toast.makeText(this,"$errCode :: $errMsg",Toast.LENGTH_LONG).show()
}
}
}