/isUserNameAvailable

https://[domain]/ws/eca/isUserNameAvailable

  • Service to see if a user_name is available.

  • Only applicable for advisors/brokers specifying user_name in the application to create an account.

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

userName

Alphanumeric

  • Begin with a letter

  • Contains at least 3 letters and 3 numbers

  • Minimum of 8 letters and numbers.

  • Maximum of 9 letters and numbers.

  • Lower case only, no spaces, no special characters.

 

Desired user_name for the applicant.

Required

JSON Request

Copy 
{
  "CSID":"<client-service-id>",
  "userName":[“<userName>]
}  

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/isUserNameAvailable -d '{"CSID":"TESTERCSID","userName": "joesm123"}'