> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# PhoneIdentifierChallenge
> Describes all the hooks and methods available to customize the Universal Login `phone-identifier-challenge` screen.
The `phone-identifier-challenge` screen is displayed when a user needs to verify their phone number by entering a one-time code. It allows the user to submit the code, resend it, switch between SMS and voice delivery, or return to the previous step.
## Import
Each screen has its own set of hooks and methods. The SDK supports **partial import** and **root import** for each screen.
* Using partial import allows you to include only the code you need for your specific use case.
* Using root import allows you to load all screens from a single bundle, which is useful when you want a unified build to handle all possible screens.
```jsx Import Example theme={null}
// root import
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react';
// partial import
import {
usePhoneIdentifierChallenge,
// Context hooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// Common hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
useResend,
// Utility hooks
useChangeLanguage,
// Methods
submitPhoneChallenge,
resendCode,
returnToPrevious,
switchToText,
switchToVoice,
} from '@auth0/auth0-acul-react/phone-identifier-challenge';
function PhoneIdentifierChallengeScreen() {
const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
return (
);
}
```
## Context Hooks
Screen-scoped hooks that provide read-only access to Auth0 context data on the `phone-identifier-challenge` screen. Import them from `@auth0/auth0-acul-react/phone-identifier-challenge`.
() => BrandingMembers}>
This hook provides branding configurations, such as logo, colors, and theme settings displayed on the `phone-identifier-challenge` screen.
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers}>
This hook provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `phone-identifier-challenge` screen.
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers}>
This hook provides information about the user's Organization if the phone challenge is Organization-scoped. Returns `null` when no Organization context is present.
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return
No Organization context
;
}
}
```
() => PromptMembers}>
This hook contains data about the current prompt in the authentication flow.
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnPhoneIdentifierChallenge}>
This hook contains details specific to the `phone-identifier-challenge` screen, including its configuration and context.
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers}>
This hook contains data related to the tenant, such as `id` and associated metadata.
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembers}>
This hook provides transaction-specific data for the `phone-identifier-challenge` screen, such as active connections and current flow state.
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers}>
This hook handles untrusted data passed to the screen, such as prefilled parameters from URL query strings.
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers}>
This hook provides details of the active user, including `username`, `email`, and available authentication methods.
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function UserProfile() {
const user = useUser();
}
```
PhoneIdentifierChallengeMembers}>
This hook returns all methods and context available on the `phone-identifier-challenge` screen.
## Methods
This method submits the one-time code entered by the user to verify their phone number and continues the authentication flow.
```jsx Example theme={null}
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function VerifyButton() {
const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
return (
);
}
```
**Method Parameters**
[PhoneChallengeOptions](/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions).
The verification code sent to the user's phone number.
The CAPTCHA response token, if CAPTCHA is enabled for this tenant.
This method resends the one-time code to the user's phone number.
```jsx Example theme={null}
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function ResendButton() {
const { resendCode } = usePhoneIdentifierChallenge();
return (
);
}
```
This method navigates the user back to the previous step in the authentication flow.
```jsx Example theme={null}
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function BackButton() {
const { returnToPrevious } = usePhoneIdentifierChallenge();
return (
);
}
```
This method switches the phone verification delivery method to SMS text message.
```jsx Example theme={null}
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function SwitchToSmsButton() {
const { switchToText } = usePhoneIdentifierChallenge();
return (
);
}
```
This method switches the phone verification delivery method to a voice call.
```jsx Example theme={null}
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function SwitchToVoiceButton() {
const { switchToVoice } = usePhoneIdentifierChallenge();
return (
);
}
```
## Common/Utility Hooks
useAuth0Themes} type="Hooks">
This hook gets the current theme options with flattened configuration from branding context.
useChangeLanguage} type="Hooks">
This hook returns a function for changing the display language on the current ACUL screen.
useCurrentScreen} type="Hooks">
This hook gets the current screen context and state.
useErrors} type="Hooks">
This hook reads and manages server, client, and developer errors on the screen.
useResend} type="Hooks">
This hook manages the resend cooldown state and timer for the `resendCode` method.
## Import
Each screen has its own set of hooks and methods. The SDK supports **partial import** and **root import** for each screen.
* Using partial import allows you to include only the code you need for your specific use case.
* Using root import allows you to load all screens from a single bundle, which is useful when you want a unified build to handle all possible screens.
```jsx Import Example theme={null}
// root import
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react';
// partial import
import {
usePhoneIdentifierChallenge,
// Context hooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// Common hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
useResend,
// Utility hooks
useChangeLanguage,
// Methods
submitPhoneChallenge,
resendCode,
returnToPrevious,
switchToText,
switchToVoice,
} from '@auth0/auth0-acul-react/phone-identifier-challenge';
function PhoneIdentifierChallengeScreen() {
const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
return (
);
}
```
## Context Hooks
Screen-scoped hooks that provide read-only access to Auth0 context data on the `phone-identifier-challenge` screen. Import them from `@auth0/auth0-acul-react/phone-identifier-challenge`.