> ## 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.
# SignupId
> Describes all the properties and methods available to customize the Universal Login `signup-id` screen.
The SignupId class implements the `signup-id` screen functionality. This screen collects the user's identifier.
## Constructors
Create an instance of SignupId screen manager:
```typescript Example theme={null}
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
email: 'test@example.com',
});
```
## 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-id` 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.
ScreenMembersOnSignupId}>
Contains details specific to the `signup-id` screen, including its configuration and context.
TenantMembers}>
Contains data related to the tenant, such as `id` and associated metadata.
TransactionMembersOnSignupId}>
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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.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 signup via different social identifiers. For example: Google, Facebook, etc.
```typescript Example theme={null}
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.federatedSignup({
connection: 'google-oauth2',
});
```
**Method Parameters**
[FederatedSignupOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions).
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-id` 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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
const identifiers = signupIdManager.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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.pickCountryCode();
```
This method handles `signup-id` related configuration. It allows signing up new users via different identifiers.
```typescript Example theme={null}
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
email: 'test@example.com',
});
```
**Method Parameters**
[SignupOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupOptions).
The user's email.
The user's identifier.
The user's phone number.
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'`).
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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
const result = signupIdManager.validateUsername('myusername');
// result => { valid: true, errors: [] }
```
**Method Parameters**
The username string to validate.