Traders Room — Sign Up API

The Sign Up API allows external systems to register new clients in the platform.

It supports:

• Creating a new user

• Passing marketing / affiliate data

• Optional email notification

• Optional instant login via autologin link

---

🎯 Use Cases

This endpoint is intended for:

• Partner platforms

• Affiliate systems

• Landing pages / funnels

• External onboarding flows

---

🌐 Endpoint

POST /tradersroom/api/auth/signup

---

🔐 Authentication

External requests must include an API key.

Header

x-api-key: <your-api-key>

Errors

Case	Response
Missing API key	401 — Secret key is required
Invalid API key	401 — Invalid secret key

---

⚙️ Request Format

Headers

Header	Required	Value
Content-Type	✅	application/json
x-api-key	✅	Provided by platform
Origin	❌	Your domain

---

📥 Request Body

Required Fields

{
  "email": "[email protected]",
  "phone": "+1234567890",
  "firstName": "Jane"
}

---

Optional Fields

{
  "lastName": "Doe",
  "affiliateID": "AFF-123",
  "campaignId": "CMP-456",
  "sourceId": "facebook_ads",
  "externalId": "your-system-id",
  "dateOfBirth": "1990-01-01",
  "sendEmail": true,
  "billing": {
    "country": "US",
    "city": "New York",
    "address": "Wall Street 1"
  }
}

---

Field Reference

Field	Type	Required	Description
email	string	✅	User email
phone	string	✅	Phone number
firstName	string	✅	First name
lastName	string	❌	Last name
sendEmail	boolean	❌	Send welcome email
affiliateID	string	❌	Affiliate identifier
campaignId	string	❌	Marketing campaign
sourceId	string	❌	Traffic source
externalId	string	❌	Your internal user ID
dateOfBirth	string	❌	YYYY-MM-DD
billing	object	❌	Address information

---

📤 Responses

✅ Success — With Autologin

{
  "id": "user-uuid",
  "url": "https://your-domain/autologin/uuid/"
}

• url allows automatic login

• Link is short-lived and should be used immediately

---

✅ Success — Without Autologin

{
  "id": "user-uuid"
}

---

❌ Error Responses

400 — Invalid Request

{
  "message": "Email, phone and first name are required",
  "providerStatus": 400
}

---

401 — Unauthorized

{
  "message": "Invalid secret key",
  "providerStatus": 401
}

---

500 — Server Error

{
  "message": "Internal server error",
  "providerStatus": 500
}

---

📡 Example Requests

Basic Registration

curl -X POST "https://your-domain/tradersroom/api/auth/signup" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "email": "[email protected]",
    "phone": "+1234567890",
    "firstName": "Jane"
  }'

---

Registration with Marketing Data

curl -X POST "https://your-domain/tradersroom/api/auth/signup" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "email": "[email protected]",
    "phone": "+1234567890",
    "firstName": "Jane",
    "affiliateID": "AFF-123",
    "campaignId": "CMP-456",
    "sourceId": "facebook_ads",
    "sendEmail": true
  }'

---

⚠️ Important Notes

• Each request creates a new user

• Ensure unique email per user

• Autologin links are temporary

• Store returned id for future reference

• API key must be kept secure

---

📊 Integration Flow (Recommended)

1. Collect user data on your side

2. Call Sign Up API

3. Receive response:

   • If url exists → redirect user

   • If not → show success message

4. Store user ID in your system