Verify User Availability | Interactive Brokers

Verify whether user is valid and available

Scope: accounts.read OR validations.read
Security Policy: HTTPS

usernamestringRequired

Verify whether user is valid and available

errorobject

hasErrorboolean

errorDescriptionstring

isValidboolean

isAvailableboolean

suggestedUserNamelist of strings

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	{
2	"error": {
3	"status": 400,
4	"error": "InvalidUsernameFormat",
5	"message": "The username contains invalid characters or is too short."
6	},
7	"hasError": true,
8	"errorDescription": "Username must be between 5 and 15 characters and contain only letters and numbers.",
9	"isValid": false,
10	"isAvailable": false,
11	"suggestedUserName": [
12	"john_doe123",
13	"john.doe2024",
14	"johndoe_official"
15	]
16	}

$	curl https://api.ibkr.com/gw/api/v1/validations/usernames/username \
>	-H "Content-Type: application/json"