/
Contact usSee pricingStart building
    Overview
    iOS SDK reference
    Android SDK reference

    React Native SDK reference

    Installation
    Changelog
    Configuration
    Pre-built UI
      UI Configuration
    Users
      Get user
      Update user
      Delete authentication factors
    Email Magic Links
      Send
      Login or create
      Authenticate
    OAuth
      Start
      Authenticate
    Passwords
      Create
      Authenticate
      Reset by Email Start
      Reset by Email
      Strength Check
    One-time Passcodes (OTP)
      Login or create via SMS
      Send via SMS
      Login or create via Email
      Send via Email
      Login or create via WhatsApp
      Send via WhatsApp
      Authenticate
    Time-Based One-Time Passcodes (TOTP)
      Create
      Authenticate
      Get Recovery Codes
      Recover
    Session Management
      Get Session
      Authenticate Session
      Revoke Session
      Update Session
      Get Tokens
    Passkeys & WebAuthn
      Register
      Authenticate
      Update
    Biometrics
      Introduction
      Register
      Authenticate
      Keystore available
      Registration available
      Remove registration
      Get sensor
      Errors
    Device Fingerprinting
      Get telemetry ID
    More Resources
      SWR & caching
      Deep linking
      Android KeyStore considerations
Get support on SlackVisit our developer forum

Contact us

Consumer Authentication

/

Mobile SDKs

/

React Native SDK reference

/

Biometrics

/

Get sensor

Get sensor

Checks if biometric sensors are available on the device. This method can be used to determine whether or not to show biometric registration options.


Method parameters


allowDeviceCredentials string
import { useStytch } from '@stytch/react-native';
import React, { useCallback, useEffect, useState } from 'react';
import { Text, TouchableOpacity, View } from 'react-native';

export const Register = () => {
  const stytch = useStytch();

  const [isSensorAvailable, setIsSensorAvailable] = useState(false);

  useEffect(() => {
    const checkSensorAvailability = async () => {
      if (stytch) {
        try {
          await stytch.biometrics.getSensor();
          setIsSensorAvailable(true);
        } catch {
          setIsSensorAvailable(false);
        }
      } else {
        setIsSensorAvailable(false);
      }
    };

    checkSensorAvailability();
  }, [stytch]);

  const registerBiometrics = useCallback(() => {
    stytch.biometrics.register({
      prompt: 'Register with Biometrics',
    });
  }, [stytch]);

  return isSensorAvailable ? (
    <View>
      <TouchableOpacity onPress={registerBiometrics}>
        <Text>Register with Biometrics</Text>
      </TouchableOpacity>
    </View>
  ) : null;
};