developers:admin:onboarding

Differences

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

Link to this comparison view

Next revision		 Previous revision
developers:admin:onboarding [2025/05/16 17:08] – created chaddevelopers:admin:onboarding [2025/11/14 17:59] (current) – [Support] frank
Line 1: Line 1:
-====== T4 Onboarding API ======+====== T4 Onboard API ======
  
 ===== Introduction ===== ===== Introduction =====
  
-The onboarding API endpoint provides a streamlined method for integrators to create fully functional user accounts in the T4 system with a single request. This endpoint is specifically designed for trading platform vendors who build on top of the T4 backend and handle user onboarding through their own website.+The onboard API endpoint provides a streamlined method for integrators to create fully functional user accounts in the T4 system with a single request. This endpoint is specifically designed for trading platform vendors who build on top of the T4 backend and handle user onboarding through their own website.
  
 By consolidating the four integration steps (user creation, account creation, market data selection, and EULA acceptance) into a single call, this API significantly simplifies the integration process and reduces development overhead. By consolidating the four integration steps (user creation, account creation, market data selection, and EULA acceptance) into a single call, this API significantly simplifies the integration process and reduces development overhead.
Line 9: Line 9:
 ===== API Endpoint ===== ===== API Endpoint =====
  
-''POST https://api.t4login.com/admin/v1/onboarding''+''POST https://api.t4login.com/admin/v1/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>
Line 363: Line 363:
 ===== 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 400: Line 400:
   * The ''apptype'' field in the User object affects available market data options   * The ''apptype'' field in the User object affects available market data options
  
-==== Account State ==== 
- 
-Newly created accounts have the following default states: 
- 
-  * ''preTradeDisabled'': true 
-  * ''enabled'': "Disabled" 
- 
-Additional configuration may be required before trading can commence. 
  
 ===== Error Handling ===== ===== Error Handling =====
Line 419: Line 411:
   * 409: Conflict (e.g., username already exists)   * 409: Conflict (e.g., username already exists)
   * 500: Server error   * 500: Server error
 +  * 503: Server busy (retry the request)
  
 Detailed error messages are provided in the response body to assist with troubleshooting. Detailed error messages are provided in the response body to assist with troubleshooting.
Line 424: Line 417:
 ===== 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.1747415313.txt.gz
  • Last modified: 2025/05/16 17:08
  • by chad