OTP

The purpose of verifying Aadhaar with OTP is to confirm the authenticity of a user's Aadhaar by verifying their registered phone number. This method sends an OTP to the phone number linked to the Aadhaar, ensuring that the user has access to the registered contact information.

How to Setup

1 Navigate to Workspace > Workflows, and click on the flow created for Verify Aadhaar with OTP. If you need understanding in creating a workflow, refer to the step-by-step guide here.

2 Hover over the plus (+) symbol and select Workflow. From the list, click Verify Aadhaar with OTP to add it.

3 Click on the newly added workflow, then select the General tab to customize your preferences.

Manage General

(*) Indicates an action to be mandatory.

Name	Description
Display Name*	Set a name to the workflow for easy identification.
Description	Summarize the purpose and functionality of this workflow module.
Enable	This toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed.
Skip	Allows the user to skip this specific workflow module during execution. When selected, it provides an option to bypass the particular workflow without affecting other modules in the sequence.
Rule	This determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here.

4 Then, click on the Configs tab to set the necessary configurations.

Manage Configs

Name

Description

Aadhaar Claims

Claims specify the information that should appear in the generated response. Note that only the selected claims will appear in the final response. The claims for Verify Aadhaar with OTP are, zip: Postal code or ZIP code associated with the address. care_of: Name of the person or entity to whom correspondence should be directed. address: The residential address. gender: Gender of the individual. raw_xml: The original, unprocessed XML data containing the Aadhaar> information. aadhaar_number_otp: The OTP sent to or associated with the Aadhaar number for verification purposes. share_code: A unique code used to share or access specific information, often for verification or authorization purposes. client_id: A unique identifier assigned to a client or user. zip_data: Data related to the postal code, which may include details like the geographic area, address information, or encoded data relevant to the ZIP code. profile_image:URL or binary data representing the user's profile picture. full_name: Full name of the individual. aadhaar_otp_verified: This denotes whether the Aadhaar verification is completed with OTP ("True" if completed, "False" if not). aadhaar_number: The Aadhaar ID number. dob: Date of birth of the individual. aadhaar_otp_verified_at: Timestamp (in Unix epoch format) indicating when Aadhaar card details were verified using OTP.

5 After you've configured everything needed, click on SAVE.

6 Proceed to attach the workflow to the relevant application for execution. Refer to the instructions on how to attach a workflow to an application here.

How it Works

1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.

2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.

3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.

4 Begin by providing the Aadhaar Number and click on Submit.

An OTP will be sent to the Aadhaar registered phone number.

5 Enter the OTP and click on Submit.

6 The verification process will be completed if the entered data is valid.

If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.

7 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.

8 Here is a sample response for Verify Aadhaar with OTP:

{
   "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
   "user_id": "mark@gmail.com",
   "workflow": "verification",
   "zip": "000000",
   "care_of": "xxxxxxxxx",
   "address": "xxxxxxxxxxxxxx",
   "gender": "x",
   "raw_xml": "https://aadhaar-kyc-docs.s3.amazonaws.com/xxxxxxxxxxxxx",
   "aadhaar_number_otp": "xxxxxxxxxxxx",
   "share_code": "xxxx",
   "client_id": "aadhaarxxxxxxxxxxxxxxxxxxxxxxxx",
   "zip_data": "https://aadhaar-kyc-docs.s3.amazonaws.com/xxxxxxxxxxxxxxxx",
   "profile_image": "/9j/4AAQSkxxxxxxxxxxxxxxxxxxxxxxxxxx",
   "full_name": "mark",
   "aadhaar_otp_verified": "true/false",
   "aadhaar_number": "334xxxxxxxxxx",
   "dob": "2000-xx-xx",
   "aadhaar_otp_verified_at": "1719569072",
}