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 Passing business / routing configuration Optional email notification Optional instant login via autologin link 🎯 Use Cases Partner platforms Affiliate systems Landing pages / funnels External onboarding flows 🌐 Endpoint POST /tradersroom/api/auth/signup πŸ” Authentication All external requests must include an API key . Header x-api-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": "user@example.com", "phone": "+1234567890", "firstName": "Jane" } πŸ“Š Full Field Reference πŸ§‘ Basic Information Field Type Required Description email string βœ… User email phone string βœ… Phone number firstName string βœ… First name middleName string ❌ Middle name lastName string ❌ Last name gender string ❌ Gender dateOfBirth string ❌ Date of birth (ISO format) nationality string ❌ Nationality passport string ❌ Passport πŸ“ž Contact Information Field Type Required Description additionalPhone string ❌ Secondary phone πŸ“’ Affiliate & Marketing Field Type Required Description affiliateID string ❌ Affiliate identifier subID string ❌ Affiliate sub-id campaignId string ❌ Campaign identifier sourceId string ❌ Traffic source meta string ❌ Additional metadata externalId string ❌ External system user ID 🏒 Business / Routing Configuration Field Type Required Description project string ❌ Project identifier desk string ❌ Desk identifier manager string ❌ Manager (id / email / name) status string ❌ Client status state string ❌ Client state ( active , live , etc.) type string ❌ Client type companyFeeGroup string ❌ Fee group processed boolean ❌ Used in custom flows πŸ›‘οΈ Verification & Permissions Field Type Required Description verificationLevel string ❌ Verification level verificationStatus string ❌ Verification status allowToCreateAsset boolean ❌ Allow asset creation agreements array ❌ Signed agreements βš™οΈ Traders Room Options Field Type Required Description sendEmail boolean ❌ Send registration email πŸ“¦ Nested Objects billing { "billing": { "country": "US", "region": "NY", "city": "New York", "postcode": "10001", "address": "Wall Street 1" } } Field Type country string region string city string postcode string address string agreements { "agreements": [ { "label": "Terms and Conditions", "ip": "127.0.0.1", "signedAt": "2026-01-01T12:00:00Z" } ] } Field Type Description label string Agreement name ip string Signing IP signedAt string ISO date πŸ“€ Responses βœ… Success β€” With Autologin { "id": "user-uuid", "url": "https://your-domain/autologin/uuid/" } URL allows instant login Valid for a short time only βœ… 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": "user@example.com", "phone": "+1234567890", "firstName": "Jane" }' Full Example curl -X POST "https://your-domain/tradersroom/api/auth/signup" \ -H "Content-Type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ -d '{ "email": "user@example.com", "phone": "+1234567890", "firstName": "Jane", "lastName": "Doe", "affiliateID": "AFF-123", "subID": "SUB-1", "campaignId": "CMP-456", "sourceId": "facebook_ads", "project": "default", "desk": "sales", "sendEmail": true }' ⚠️ Important Notes Each request creates a new user Email should be unique Autologin link is temporary Store returned id in your system API key must be kept secure Some system fields are automatically managed and cannot be overridden πŸ“Š Recommended Integration Flow Collect user data Call Sign Up API Handle response: If url exists β†’ redirect user Otherwise β†’ show success message Store user ID