Skip to main content

Zero-tap authentication templates | Developer Documentation

Zero-tap authentication templates

Updated: Feb 6, 2026
Upcoming deprecation: Starting April 15, 2026, the PendingIntent-based handshake method for authentication templates will be deprecated. If you are currently using PendingIntent to initiate handshakes or verify app identity, the OTP Android SDK is the preferred way to migrate.
Zero-tap authentication templates allow your users to receive one-time passwords or codes via WhatsApp without having to leave your app.
When a user in your app requests a password or code and you deliver it using a zero-tap authentication template, the WhatsApp client simply broadcasts the included password or code and your app can capture it immediately with a broadcast receiver.
From your user’s perspective, they request a password or code in your app and it appears in your app automatically. If your app user happens to check the message in the WhatsApp client, they will only see a message displaying the default fixed text: < code > is your verification code.
Like one-tap autofill button authentication templates, when the WhatsApp client receives the template message containing the user’s password or code, we perform a series of eligibility checks. If the message fails this check and we are unable to broadcast the password or code, the message will display either a one-tap autofill button or a copy code button. For this reason, when you create a zero-tap authentication template, you must include a one-tap autofill and copy code button in your post body payload, even if the user may never see one of these buttons.
Note: The OTP Android SDK features a simplified workflow for implementing one-tap and zero-tap authentication templates. You can learn how to use it below.

Limitations

Zero-tap is only supported on Android. If you send a zero-tap authentication template to a WhatsApp user who is using a non-Android device, the WhatsApp client will display a copy code button instead.
URLs, media, and emojis are not supported.

Best practices

    Do not make WhatsApp your default password/code delivery method.Make it clear to your app users that the password or code will be automatically delivered to your app when they select WhatsApp for delivery.Link to our About security codes that automatically fill on WhatsApp help center article if your users are worried about auto-delivery of the password or code.After the password/code is used in your app, make it clear to your app user that it was received successfully.
    Here are some examples that make it clear to an app user that their code will automatically appear in the app.

    App signing key hash

    You must include your app signing key hash in your post body.
    To calculate your hash, follow Google’s instructions for computing your app’s hash string.
    Alternatively, if you follow Google’s instructions and download your app signing key certificate (step 1), you can use your certificate with the sms_retriever_hash_v9.sh shell script to compute the hash. For example:
    ./sms_retriever_hash_v9.sh --package "com.example.myapplication" --keystore ~/.android/debug.keystore
    

    Supported apps

    The supported_apps array allows you define pairs of app package names and signing key hashes for up to 5 apps. This can be useful if you have different app builds and want each of them to be able to initiate the handshake:
    
    
    Alternatively, if you are using Graph API version 20.0 or older and have only a single app, you can define the app’s package name and signing key hash as buttons object properties, but this is not recommended as we will stop supporting this method starting with version 21.0:
    
    

    Handshake

    You must signal to the WhatsApp client to expect imminent delivery of a password or code. You can do this by initiating a “handshake”.
    A handshake is an Android intent and public class that you implement but that the WhatsApp client can start.
    When a user in your app requests a password or code to be delivered to their WhatsApp number, first initiate the handshake, then call our API to send the authentication template message. When the WhatsApp client receives the message, it will perform an eligibility check, and if there are no errors, start a broadcast.
    If you do not initiate the handshake before sending the message, or the message fails an eligibility check, the broadcast will not be started. Instead, the delivered message will display a one-tap autofill button, if able to do so. If unable to do so, it will display a copy code button.

    Eligibility Check

    The WhatsApp client performs the following checks when it receives an authentication template message. If any check fails, it will attempt to display the one-tap autofill button in the message. If unable to do so, it will fall back to a copy code button.
      The handshake was initiated no more than 10 minutes ago (or no more than the number of minutes indicated by the template’s code_expiration_minutes property, if present).The package name in the message (defined in the package_name property in the components array upon template creation) matches the package name set on the intent. The match is determined through the getCreatorPackage method called in the PendingIntent object provided by your application. See One-Tap Autofill Button Class.The app signing key hash in the message (defined in the signature_hash property in the components array upon template creation) matches your installed app’s signing key hash.Your app has defined a one-tap autofill button activity and class to receive the password or code.Your app has defined a zero-tap broadcast receiver and class to receive the password or code.

      Android notifications

      Android notifications indicating receipt of a WhatsApp authentication template message will only appear on the user’s Android device if:
        The user is logged into the WhatsApp app or WhatsApp Business app with the phone number (account) that the message was sent to.The user is logged into your app.Android OS is KitKat (4.4, API 19) or above.Show notifications is enabled (Settings > Notifications) in the WhatsApp app or WhatsApp Business app.Device level notification is enabled for the WhatsApp app or WhatsApp Business app.Prior message threads in the WhatsApp app or WhatsApp Business app between the user and your business are not muted.

        Using the SDK

        The OTP Android SDK can be used to perform handshakes, as well as other functions in both one-tap and zero-tap authentication templates.
        To access SDK functionality, add the following configuration to your Gradle file:
        dependencies {
            …
            implementation 'com.whatsapp.otp:whatsapp-otp-android-sdk:1.0.0'
            …
        }
        
        To your repositories, add mavenCentral():
        repositories {
            …
            mavenCentral()
            …
        }
        

        Zero-tap broadcast receiver

        Declare a Receiver and intent filter that can receive the one-time password or code. The intent filter must have the action name com.whatsapp.otp.OTP_RETRIEVED.
        <receiver
           android:name=".app.receiver.OtpCodeReceiver"
           android:enabled="true"
           android:exported="true">
           <intent-filter>
               <action android:name="com.whatsapp.otp.OTP_RETRIEVED" />
           </intent-filter>
        </receiver>
        
        This is the receiver that the WhatsApp app or WhatsApp Business app will start once the authentication template message is received and it passes all eligibility checks.

        Zero-tap receiver class

        Using the SDK
        We recommend using the SDK to declare a receiver. Define a class that extends BroadcastReceiver, then define the onReceive method, passing in your context and intent. Instantiate a WhatsAppOtpIncomingIntentHandler object, then run the .processOtpCode() method which will receive the intent, validate the handshake ID against the expected value you stored during handshake initiation, and handle errors.
        public class OtpCodeReceiver extends BroadcastReceiver {
        
          @Override
          public void onReceive(Context context, Intent intent) {
            WhatsAppOtpIncomingIntentHandler whatsAppOtpIncomingIntentHandler = new WhatsAppOtpIncomingIntentHandler();
        
            // Retrieve the expected handshake ID that was stored during handshake initiation
            String expectedHandshakeId = retrieveStoredHandshakeId();
        
            whatsAppOtpIncomingIntentHandler.processOtpCode(intent,
              expectedHandshakeId,
              (code) -> {
                // The handshake ID has been validated by the SDK
                validateCode(code);
              },
              // call your function to handle errors
              (error, exception) -> handleError(error, exception));
          }
        }
        
        Without the SDK
        The broadcast receiver class should extract and validate the request_id (handshake ID) from the intent to ensure the OTP code is coming from a legitimate handshake initiated by your app:
        public class OtpCodeReceiver extends BroadcastReceiver {
        
            @Override
            public void onReceive(Context context, Intent intent) {
                String incomingRequestId = intent.getStringExtra("request_id");
        
                // Retrieve the previously stored handshake ID
                String storedRequestId = retrieveStoredRequestId();
        
                // Validate the handshake ID matches
                if (storedRequestId != null && storedRequestId.equals(incomingRequestId)) {
                    // use OTP code
                    String otpCode = intent.getStringExtra("code");
                    // ...
                }
            }
        }
        

        One-tap autofill button activity

        Optional.
        If you want the delivered message to be able to fall back to a one-tap autofill button if the message fails the eligibility check, implement this activity and intent filter in your app to receive the one-time password or code.
        The intent filter must have the action name com.whatsapp.otp.OTP_RETRIEVED.
        <activity
           android:name=".ReceiveCodeActivity"
           android:enabled="true"
           android:exported="true"
           android:launchMode="standard">
           <intent-filter>
               <action android:name="com.whatsapp.otp.OTP_RETRIEVED" />
           </intent-filter>
        </activity>
        
        This is the activity that the WhatsApp client will start if the message fails the eligibility check but is still eligible to display a one-tap autofill button.

        One-tap autofill button activity class

        Optional.
        If you want the message to be able to display a one-tap autofill button if the if fails an eligibility check, define the activity public class that can accept the code once the user taps the button. The activity should validate the request_id (handshake ID) to ensure the OTP code is coming from a legitimate handshake initiated by your app.
        public class ReceiveCodeActivity extends AppCompatActivity {
        
           @Override
           protected void onCreate(Bundle savedInstanceState) {
               super.onCreate(savedInstanceState);
               Intent intent = getIntent();
        
               // Extract the handshake ID from the intent
               String incomingRequestId = intent.getStringExtra("request_id");
        
               // Retrieve the previously stored handshake ID
               String storedRequestId = retrieveStoredRequestId();
        
               // Validate the handshake ID matches
               if (storedRequestId != null && storedRequestId.equals(incomingRequestId)) {
                 // use OTP code
                 String otpCode = intent.getStringExtra("code");
                 // ...
               }
           }
        }
        

        Initiating the handshake

        Using the SDK
        The preferred method for handshake initation is via SDK. Performing a handshake via SDK can be done by instantiating a WhatsAppOtpHandler object and passing in your context to the .sendOtpIntentToWhatsApp() method. The method returns a UUID (handshake ID) that must be stored and used to validate the incoming OTP code later:
        WhatsAppOtpHandler whatsAppOtpHandler = new WhatsAppOtpHandler();
        UUID handshakeId = whatsAppOtpHandler.sendOtpIntentToWhatsApp(context);
        // Store handshakeId to validate the received OTP code later
        
        Without the SDK
        This example demonstrates one way to initiate a handshake with the WhatsApp app or WhatsApp Business app. The handshake now includes a request_id (UUID) that must be stored and validated when receiving the OTP code.
        private String currentRequestId;
        
        public void sendOtpIntentToWhatsApp() {
           // Generate a unique handshake ID
           currentRequestId = UUID.randomUUID().toString();
           // Store this ID for later validation when receiving the OTP
           storeRequestId(currentRequestId);
        
           // Send OTP_REQUESTED intent to both WA and WA Business App
           sendOtpIntentToWhatsApp("com.whatsapp", currentRequestId);
           sendOtpIntentToWhatsApp("com.whatsapp.w4b", currentRequestId);
        }
        
        private void sendOtpIntentToWhatsApp(String packageName, String requestId) {
        
          /**
          * Starting with Build.VERSION_CODES.S, it will be required to explicitly
          * specify the mutability of  PendingIntents on creation with either
          * (@link #FLAG_IMMUTABLE} or FLAG_MUTABLE
          */
          int flags = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S ? FLAG_IMMUTABLE : 0;
          PendingIntent pi = PendingIntent.getActivity(
              getApplicationContext(),
              0,
              new Intent(),
              flags);
        
          // Send OTP_REQUESTED intent to WhatsApp
          Intent intentToWhatsApp = new Intent();
          intentToWhatsApp.setPackage(packageName);
          intentToWhatsApp.setAction("com.whatsapp.otp.OTP_REQUESTED");
          // WA will use this to verify the identity of the caller app.
          Bundle extras = intentToWhatsApp.getExtras();
          if (extras == null) {
             extras = new Bundle();
          }
          extras.putParcelable("_ci_", pi);
          // Add the handshake ID for secure validation
          intentToWhatsApp.putExtra("request_id", requestId);
          intentToWhatsApp.putExtras(extras);
          getApplicationContext().sendBroadcast(intentToWhatsApp);
        }
        

        Checking if WhatsApp is installed

        You can check WhatsApp installation before offering WhatsApp as an option if you expect both WhatsApp and your app to be on the same device.
        First, you need to add the following to your AndroidManifest.xml file:
        
        
        <queries>
            <package android:name="com.whatsapp"/>
            <package android:name="com.whatsapp.w4b"/>
        </queries>
        Instantiate the WhatsAppOtpHandler object:
        WhatsAppOtpHandler whatsAppOtpHandler = new WhatsAppOtpHandler();
        
        Check if the WhatsApp client is installed by passing the .isWhatsAppInstalled() method as the clause in an If statement:
        If (whatsAppOtpHandler.isWhatsAppInstalled(context)) {
            // ... do something
        }
        

        Error signals

        See Error Signals that can help with debugging.

        Handshake ID Error Codes

        The following error codes may be returned when using the SDK with handshake ID validation:
        Error Code Description
        HANDSHAKE_ID_MISSING
        The handshake ID was not included in the intent from WhatsApp
        HANDSHAKE_ID_INVALID_FORMAT
        The handshake ID is not a valid UUID format
        HANDSHAKE_ID_MISMATCH
        The handshake ID in the intent does not match the expected value