developers:admin:onboarding

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developers:admin:onboarding [2025/11/14 17:57] – [Introduction] frankdevelopers:admin:onboarding [2026/09/10 09:42] (current) – chad
Line 9: Line 9:
 ===== API Endpoint ===== ===== API Endpoint =====
  
-''POST https://api.t4login.com/admin/v1/onboard''+''POST https://api.t4login.com/admin/v1/users/onboard''
  
 ===== Authentication ===== ===== Authentication =====
Line 17: Line 17:
 ===== Request Format ===== ===== Request Format =====
  
-The onboarding request combines all necessary user, account, market data, and EULA information into a single JSON payload:+The onboard request combines all necessary user, account, market data, and EULA information into a single JSON payload:
  
 <code> <code>
 { {
     "User": {     "User": {
 +        "templateUser": "DefaultTemplate",
         "username": "[email protected]",         "username": "[email protected]",
         "password": "SecurePassword123!",         "password": "SecurePassword123!",
Line 90: Line 91:
  
 | **Field** | **Type** | **Description** | **Required** | | **Field** | **Type** | **Description** | **Required** |
 +| templateUser| string | Template user account to base settings on | No|
 | username | string | Unique username for the user (typically email address) | Yes | | username | string | Unique username for the user (typically email address) | Yes |
 | password | string | User's password (must meet security requirements) | Yes | | password | string | User's password (must meet security requirements) | Yes |
Line 363: Line 365:
 ===== Optional Components ===== ===== Optional Components =====
  
-The onboarding endpoint provides flexibility by making certain components optional:+The onboard endpoint provides flexibility by making certain components optional:
  
   * **MarketData**: If omitted, the user will not have market data access until configured separately.   * **MarketData**: If omitted, the user will not have market data access until configured separately.
Line 417: Line 419:
 ===== Support ===== ===== Support =====
  
-For questions, issues, or assistance with the Onboarding API, please contact:+For questions, issues, or assistance with the Onboard API, please contact:
   * Email: [email protected]   * Email: [email protected]
  • developers/admin/onboarding.1763143057.txt.gz
  • Last modified: 2025/11/14 17:57
  • by frank