SignupRequest

Package: @nauth-toolkit/client Type: Request

Data transfer object for user registration requests.

import { SignupRequest } from '@nauth-toolkit/client';

Properties

Property	Type	Required	Description
email	string	Yes	User email address. Must be valid email format.
password	string	Yes	User password. Must meet backend password requirements.
firstName	string	No	User first name
lastName	string	No	User last name
phone	string	No	Phone number in E.164 format (e.g., +14155551234)
metadata	Record<string, unknown>	No	Custom metadata object (saved to user record)

Example

{
  "email": "newuser@example.com",
  "password": "SecurePass123!",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+14155551234",
  "metadata": {
    "customField": "value",
    "source": "web",
    "referralCode": "ABC123"
  }
}

Related Types

• AuthResponse - Response containing user/tokens or challenge
• AuthUser - Complete user profile
• AuthUserSummary - Minimal user info in response

Used By

• NAuthClient.signup() - Accepts SignupRequest
• Angular AuthService.signup() - Observable wrapper