React Native Firebase
    Preparing search index...

    Module @react-native-firebase/phone-number-verification

    Android only. The Firebase Phone Number Verification SDK does not support iOS or Web. Every exported function throws when Platform.OS !== 'android'.

    Functions

    enableTestSession

    Enables a test session for SIM-less testing. Must be called only once per app instance; subsequent calls will reject with error code pnv/test-session-already-enabled.

    exchangeCredentialResponseForPhoneNumber

    Exchanges a Credential Manager response for a verified phone number. Part of the custom verification flow.

    getDigitalCredentialPayload

    Generates a digital credential payload for use with Android Credential Manager. Part of the custom verification flow.

    getVerificationSupportInfo

    Checks if the device's SIM card(s) support phone number verification.

    getVerifiedPhoneNumber

    Initiates the phone number verification flow, including user consent and token generation. A consent dialog will be presented to the user.

    Interfaces

    PnvError

    Error thrown when a Phone Number Verification operation fails.

    VerificationSupportResult

    Result describing whether a specific SIM slot supports phone number verification.

    VerifiedPhoneNumberTokenResult

    Result of a successful phone number verification, containing the verified phone number and a JWT token for server-side validation.

    Type Aliases

    PnvErrorCode

    Union of all PnvErrorCode string values.

    VerificationSupportStatus

    Status indicating why a SIM slot does or does not support phone number verification. Maps to the native VerificationSupportStatus IntDef constants.

    Variables

    PnvErrorCode

    Error codes returned by the Firebase Phone Number Verification SDK. These map to FirebasePnvStatusCodes constants from the native SDK.