Auth Registration

SwitchWallet Merchant Signup Guide

This guide will walk you through the complete process of signing up as a merchant on the SwitchWallet platform.

Overview

The signup process consists of two main steps:

1. Request Email Verification OTP - Verify your email address

2. Complete Registration - Create your merchant account

After successful registration, your account will be created with:

• User account credentials

• Merchant profile

• Wallet addresses for all supported cryptocurrencies (automatically generated)

---

Step 1: Request Email Verification OTP

Endpoint

POST /api/v2/auth/register/otp

Request Body

{
  "emailAddress": "[email protected]"
}

Example Request (cURL)

curl -X POST "https://api.switchwallet.com/api/v2/auth/register/otp" \
  -H "Content-Type: application/json" \
  -d '{
    "emailAddress": "[email protected]"
  }'

Expected Response

{
  "isSuccessful": true,
  "httpStatusCode": 200,
  "message": "OTP sent successfully"
}

What Happens

• An OTP (One-Time Password) code is sent to your email address

• The OTP is valid for a limited time (check your email for expiration details)

• Note: For Sandbox/Staging environment, OTP is required. For Production, OTP validation may vary.

---

Step 2: Complete Registration

Endpoint

POST /api/v2/auth/register

Request Body

{
  "emailAddress": "[email protected]",
  "businessName": "My Business Inc.",
  "firstName": "John",
  "lastName": "Doe",
  "otpCode": "123456",
  "password": "SecurePassword123!",
  "confirmPassword": "SecurePassword123!",
  "sentFrom": "Sandbox"
}

Field Descriptions

Field	Type	Required	Description
emailAddress	string	Yes	Your business email address (must be unique)
businessName	string	Yes	Your business/company name
firstName	string	Yes	Your first name
lastName	string	Yes	Your last name
otpCode	string	Yes (Sandbox)	The OTP code received in Step 1
password	string	Yes	Your account password (must meet security requirements)
confirmPassword	string	Yes	Must match the password field exactly
sentFrom	enum	Yes	Either "Sandbox" or "Production"

sentFrom Values

• "Sandbox" - For testing/staging environment (requires OTP verification)

• "Production" - For production environment (OTP requirements may vary)

Example Request (cURL)

curl -X POST "https://api.switchwallet.com/api/v2/auth/register" \
  -H "Content-Type: application/json" \
  -d '{
    "emailAddress": "[email protected]",
    "businessName": "My Business Inc.",
    "firstName": "John",
    "lastName": "Doe",
    "otpCode": "123456",
    "password": "SecurePassword123!",
    "confirmPassword": "SecurePassword123!",
    "sentFrom": "Sandbox"
  }'

Success Response

{
  "isSuccessful": true,
  "httpStatusCode": 200,
  "message": "Registration successful",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "refresh_token_here",
    "expiresAtTimestamp": 1704067200000
  }
}

Error Responses

Email Already Exists

{
  "isSuccessful": false,
  "httpStatusCode": 400,
  "message": "Email already exists"
}

Invalid OTP Code (Sandbox)

{
  "isSuccessful": false,
  "httpStatusCode": 400,
  "message": "Invalid OTP code"
}

Passwords Don't Match

{
  "isSuccessful": false,
  "httpStatusCode": 400,
  "message": "Password does not match"
}

Password Requirements Not Met

{
  "isSuccessful": false,
  "httpStatusCode": 400,
  "message": "User account could not be created right now"
}

---

Complete Registration Flow

Sandbox/Staging Environment

1. Request OTP

   • Send email address to /api/v2/auth/register/otp

   • Check your email for the OTP code

2. Complete Registration

   • Fill in all registration fields

   • Include the OTP code from your email

   • Set sentFrom to "Sandbox"

Production Environment

1. Request OTP (if required)

   • Send email address to /api/v2/auth/register/otp

   • Follow production-specific instructions

2. Complete Registration

   • Fill in all registration fields

   • Set sentFrom to "Production"

---

What Happens After Registration

Once your registration is successful:

1. ✅ User Account Created - Your login credentials are set up

2. ✅ Merchant Profile Created - Your business profile is registered

3. ✅ Wallet Generation Initiated - Wallet addresses are automatically generated for all supported cryptocurrencies

4. ✅ Authentication Token Issued - You receive an access token for API calls

5. ✅ 2FA Setup (Sandbox) - Two-factor authentication is automatically enabled

NB: You will need to setup your 2FA on production dashboard

Wallet Address Generation

After registration, the system automatically:

• Creates wallet entities for all active parent cryptocurrencies

• Sends wallet creation commands to generate wallet mnemonics

• Triggers address generation workers to create initial wallet addresses(this may take a little time, cos the request is queued)

---

Using Your Access Token

After successful registration, use the returned token in subsequent API requests:

curl -X GET "https://api.switchwallet.com/api/v2/merchant/wallets" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"

Token Expiration

• The expiresAtTimestamp field indicates when your token expires

• Use the refreshToken to get a new access token via /api/v2/auth/refreshToken

---

Example: Complete Signup Script

// Step 1: Request OTP
const requestOTP = async (email) => {
  const response = await fetch('https://api.switchwallet.com/api/v2/auth/register/otp', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ emailAddress: email })
  });
  return await response.json();
};

// Step 2: Register
const register = async (registrationData) => {
  const response = await fetch('https://api.switchwallet.com/api/v2/auth/register', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(registrationData)
  });
  return await response.json();
};

// Usage
(async () => {
  const email = '[email protected]';
  
  // Step 1: Get OTP
  const otpResponse = await requestOTP(email);
  console.log('OTP Response:', otpResponse);
  
  // Step 2: Register (use OTP from email)
  const registerResponse = await register({
    emailAddress: email,
    businessName: 'My Business Inc.',
    firstName: 'John',
    lastName: 'Doe',
    otpCode: '123456', // From email
    password: 'SecurePassword123!',
    confirmPassword: 'SecurePassword123!',
    sentFrom: 'Sandbox'
  });
  
  console.log('Registration Response:', registerResponse);
  console.log('Access Token:', registerResponse.data.token);
})();

---

Troubleshooting

OTP Not Received

• Check your spam/junk folder

• Verify the email address is correct

• Wait a few minutes and try again

• Contact support if issue persists

Invalid OTP Error

• Ensure OTP hasn't expired (typically valid for 5-10 minutes)

• Check that you're using the most recent OTP sent

• Make sure there are no extra spaces when copying the OTP

Email Already Exists

• This email is already registered

• Try logging in instead at /api/v2/auth/login

• Use password reset if you forgot your password

Password Requirements

• Minimum length requirements (typically 8+ characters)

• Must include uppercase, lowercase, numbers, and/or special characters

• Ensure password and confirmPassword match exactly

---

Next Steps After Registration

1. Login - Use your credentials at /api/v2/auth/login

2. View Wallets - Check your generated wallet addresses

3. Generate Deposit Addresses - Create addresses for receiving payments

4. Configure Webhooks - Set up payment notifications

5. Review API Documentation - Explore available endpoints

---

Support

For additional help or questions:

• Email: [email protected]

• Documentation: https://docs.switchwallet.com

• API Status: https://status.switchwallet.com

---

Last Updated: November 2025