> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.generaltranslation.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Signup

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/generaltranslationinc/Tx-zTp2kMjjdY0gu/docs/images/cdy7uua7fh8z/5IrmDuvj5xma8DmkIMJ7ol/42363cde670f86561666c9e930f76883/Screenshot_2025-02-05_at_15.43.23.png?fit=max&auto=format&n=Tx-zTp2kMjjdY0gu&q=85&s=56449c420b6e7694467c2e51df68ffc2" alt="ACUL Signup screen image" width="374" height="736" data-path="docs/images/cdy7uua7fh8z/5IrmDuvj5xma8DmkIMJ7ol/42363cde670f86561666c9e930f76883/Screenshot_2025-02-05_at_15.43.23.png" />
</Frame>

```ts Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: 'test@example.com',
 password: 'P@$wOrd123!',
});
```

## Constructors

<ParamField body="Signup" type="Constructor" />

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>} />

<ParamField body="client" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>} />

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>} />

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>} />

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>} />

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>} />

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>} />

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} />

<ParamField body="user" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>} />

<ParamField body="screenIdentifier" type="string" />

## Methods

<ParamField body="federatedSignup" type="Promise<void>">
  Handles the submission of the social signup form.

  #### Remarks

  This method 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'
  });
  ```

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions">FederatedSignupPayloadOptions</a></span>}>
      **Properties**

      <ParamField body="connection" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  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.
</ParamField>

<ParamField body="getSignupIdentifiers" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}>
  **`Utility Feature`**

  Returns the list of enabled identifiers for the signup form,
  marking each as required or optional based on transaction config.

  Array of identifier objects (e.g., email, phone, username).

  ```ts Example theme={null}
  const signup = new Signup();
  const identifiers = signup.getSignupIdentifiers();
  // [{ type: 'email', required: true }, { type: 'username', required: false }]
  ```
</ParamField>

<ParamField body="pickCountryCode" type="Promise<void>">
  ```ts Example theme={null}
  import Signup from "@auth0/auth0-acul-js/signup";
  const signupManager = new Signup();

  signupManager.pickCountryCode();
  ```
</ParamField>

<ParamField body="signup" type="Promise<void>">
  #### Remarks

  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!',
  });
  ```

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}>
      **Properties**

      <ParamField body="captcha?" type="string" />

      <ParamField body="email?" type="string" />

      <ParamField body="password?" type="string" />

      <ParamField body="phoneNumber?" type="string" />

      <ParamField body="username?" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validatePassword" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}>
  **`Utility Feature`**

  An object of type [PasswordValidationResult](/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why.

  <Expandable title="Parameters">
    <ParamField body="password" type="string">
      `string`
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validateUsername" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}>
  **`Utility Feature`**

  Validates a given username against the current username policy
  defined in the transaction context.

  Result object indicating whether the username is valid and why.

  ```ts Example theme={null}
  const signup = new Signup();
  const result = signup.validateUsername('myusername');
  // result => { valid: true, errors: [] }
  ```

  <Expandable title="Parameters">
    <ParamField body="username" type="string">
      `string`

      The username string to validate.
    </ParamField>
  </Expandable>
</ParamField>
