> ## 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.
# PhoneIdentifierEnrollment
> Describes all the hooks and methods available to customize the Universal Login `phone-identifier-enrollment` screen.
The `phone-identifier-enrollment` screen is displayed when a user needs to enroll a phone number as an identifier. It allows the user to select their preferred verification method (SMS or voice call) and continue the enrollment process 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 { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react';
// partial import
import {
usePhoneIdentifierEnrollment,
// Context hooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// Common hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
// Utility hooks
useChangeLanguage,
// Methods
continuePhoneEnrollment,
returnToPrevious,
} from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function PhoneIdentifierEnrollmentScreen() {
const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
return (
);
}
```
## Context Hooks
Screen-scoped hooks that provide read-only access to Auth0 context data on the `phone-identifier-enrollment` screen. Import them from `@auth0/auth0-acul-react/phone-identifier-enrollment`.
() => BrandingMembers}>
This hook provides branding configurations, such as logo, colors, and theme settings displayed on the `phone-identifier-enrollment` screen.
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers}>
This hook provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `phone-identifier-enrollment` screen.
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers}>
This hook provides information about the user's Organization if the phone enrollment is Organization-scoped. Returns `null` when no Organization context is present.
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
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-enrollment';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnPhoneIdentifierEnrollment}>
This hook contains details specific to the `phone-identifier-enrollment` screen, including its configuration and context.
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
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-enrollment';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembers}>
This hook provides transaction-specific data for the `phone-identifier-enrollment` screen, such as active connections and current flow state.
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
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-enrollment';
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-enrollment';
function UserProfile() {
const user = useUser();
}
```
PhoneIdentifierEnrollmentMembers}>
This hook returns all methods and context available on the `phone-identifier-enrollment` screen.
## Methods
This method submits the user's preferred phone verification method and continues the enrollment flow.
```jsx Example theme={null}
import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function EnrollButton() {
const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
return (
);
}
```
**Method Parameters**
[PhoneEnrollmentOptions](/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions).
The delivery method for the verification code. Use "text" for SMS or "voice" for a phone call.
This method navigates the user back to the previous step in the authentication flow.
```jsx Example theme={null}
import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function BackButton() {
const { returnToPrevious } = usePhoneIdentifierEnrollment();
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.
## 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 { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react';
// partial import
import {
usePhoneIdentifierEnrollment,
// Context hooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// Common hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
// Utility hooks
useChangeLanguage,
// Methods
continuePhoneEnrollment,
returnToPrevious,
} from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function PhoneIdentifierEnrollmentScreen() {
const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
return (
);
}
```
## Context Hooks
Screen-scoped hooks that provide read-only access to Auth0 context data on the `phone-identifier-enrollment` screen. Import them from `@auth0/auth0-acul-react/phone-identifier-enrollment`.