IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

PhoneAuthCredential

public class PhoneAuthCredential extends AuthCredential implements Cloneable

java.lang.Object
↳	com.google.firebase.auth.AuthCredential
	↳	com.google.firebase.auth.PhoneAuthCredential

Wraps phone number and verification information for authentication purposes.

Summary

Constants
`static final Parcelable.Creator<PhoneAuthCredential>`	`CREATOR`

Public fields
`@Nullable String`	`smsCode`

Public methods
`@NonNull String`	`getProvider()` Returns the unique string identifier for the provider type with which the credential is associated.
`@NonNull String`	`getSignInMethod()` Returns the unique string identifier for the sign in method with which the credential is associated.
`@Nullable String`	`getSmsCode()` Gets the auto-retrieved SMS verification code if applicable.

Inherited Constants

From android.os.Parcelable

`static final int`	`CONTENTS_FILE_DESCRIPTOR = 1`
`static final int`	`PARCELABLE_WRITE_RETURN_VALUE = 1`

Inherited methods

From android.os.Parcelable

abstract int

describeContents()

Constants

CREATOR

public static final Parcelable.Creator<PhoneAuthCredential> CREATOR

Public fields

smsCode

public @Nullable String smsCode

Public methods

getProvider

public @NonNull String getProvider()

Returns the unique string identifier for the provider type with which the credential is associated.

getSignInMethod

public @NonNull String getSignInMethod()

Returns the unique string identifier for the sign in method with which the credential is associated. Should match that returned by fetchSignInMethodsForEmail after this user has signed in with this type of credential.

getSmsCode

public @Nullable String getSmsCode()

Gets the auto-retrieved SMS verification code if applicable. When SMS verification is used, you will be called back first via onCodeSent, and later onVerificationCompleted with a containing a non-null SMS code if auto-retrieval succeeded. If Firebase used another approach to verify the phone number and triggers a callback via onVerificationCompleted, then SMS code can be null.