Headless - OTP

​

Prerequisites

1. Make sure you have followed the SDK Setup Guide before starting with this document.
2. Ensure you have admin access to the OTPless Account.

​

Configure OTP Auth on Dashboard

1. Log in to the OTPless dashboard with your registered email ID.
2. Go to Configure Channel.
3. Enable the phone or email channel based on your requirement.
4. When you enable the channel, you will see the option to configure the auth method and delivery channel.
5. Choose OTP as the auth method.

​

Choose your Programming Language:

• Java
• Kotlin

​

Step 3: Get Auth Token

Awesome! You’ve completed the client-side integration. Now, after the OTP is verified, you’ll get a callback with the ONETAP response containing the token. You’ll need to parse the token from the response JSON.

Sample Callback JSON

{
  "responseType": "ONETAP",
  "statusCode": 200,
  "response": {
    "status": "SUCCESS",
    "token": "unique_token_here",
    "userId": "unique_user_id_here",
    "timestamp": "ISO_timestamp_here",
    "identities": [
      {
        "identityType": "MOBILE",
        "identityValue": "919899038845",
        "channel": "OTP",
        "methods": [
          "SMS"
        ],
        "verified": true,
        "verifiedAt": "2024-08-05T13:57:56Z"
      }
    ],
    "idToken": "jwt_token",
    "network": {
      "ip": "127.0.0.1",
      "timezone": "Asia/Kolkata",
      "ipLocation": {}
    },
    "deviceInfo":{},
    "sessionInfo":{},
    "firebaseInfo":{}
  }
}

How to parse the token from response?

​

🏁 Check Point : Verify Auth Token

Once you have retrieved the token, send it to your backend and call the verify token API.

​

Additional Functions

​

Get Auto Read OTP

For WhatsApp and SMS, you can auto-read the OTP if the user’s WhatsApp account or SIM is on the same device. You will get the OTP in the HeadlessResponse itself with OTP_AUTO_READ responseType.

​

Initiate Google Phone Hint API for Phone Number Suggestion

The Google Phone Hint API suggests phone numbers stored on the user’s device, prompting them to choose one. If selected, the number can be applied to the input field, reducing manual entry and errors. OTPless offers this feature for a seamless phone number entry process during authentication or registration.

​

Select the event to trigger the Phone Hint API.

• Inside OnCreate()
• On Event(button click, focus change and custom events)