> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-actions-triggers-prototype.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Signup
> Describes all the properties and methods available to customize the Universal Login `signup` screen.
The Signup class implements the `signup` screen functionality. This screen collects the user's identifier and password. Depending on your tenant, this identifier can be an email, phone number, or username.
## Constructors
Create an instance of Signup screen manager:
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.signup({
email: 'test@example.com',
password: 'P@$wOrd123!',
});
```
## Properties
BrandingMembers}>
Provides branding-related configurations, such as branding theme and settings.
ClientMembers}>
Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `signup` screen.
OrganizationMembers}>
Provides information about the user's Organization, such as `id` and `name`.
PromptMembers}>
Contains data about the current prompt in the authentication flow.
ScreenMembersOnSignup}>
Contains details specific to the `signup` screen, including its configuration and context.
TenantMembers}>
Contains data related to the tenant, such as `id` and associated metadata.
TransactionMembersOnSignup}>
Provides transaction-specific data, such as active identifiers and flow states.
UntrustedDataMembers}>
Handles untrusted data passed to the SDK, such as user input during login.
UserMembers}>
Details of the active user, including `username`, `email`, and `roles`.
## Methods
This method changes the display language of the Universal Login page.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.changeLanguage({
language: 'fr',
});
```
**Method Parameters**
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
When set to `'session'`, the selected language persists for the duration of the session.
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
This method handles the submission of the social signup form. It is similar to the [signup](#signup) method but is used for social signups.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.federatedSignup({
connection: 'google-oauth2',
});
```
**Method Parameters**
[FederatedSignupPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions).
The social connection name to use.
Error[]}>
This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
Identifier[] | null}>
This method returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config. An array of identifier objects (for example, email, phone, username).
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const identifiers = signupManager.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
```
This method redirects the user to the country code selection list, where they can update the country code prefix for their phone number.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.pickCountryCode();
```
This method handles the submission of the signup form.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.signup({
email: 'test@example.com',
password: 'P@$wOrd123!',
});
```
**Method Parameters**
[SignupPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPayloadOptions).
The user's email.
The user's identifier.
The user's phone number.
The user's password.
The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled.
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
PasswordValidationResult}>
This method returns an object of type [PasswordValidationResult](/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validatePassword('P@$wOrd123!');
```
**Method Parameters**
The user's password.
UsernameValidationResult}>
This method validates a given username against the current username policy defined in the transaction context. It returns an object indicating whether the username is valid and why.
```typescript Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validateUsername('myusername');
// result => { valid: true, errors: [] }
```
**Method Parameters**
The username string to validate.