Request Trading Permission
Send a request to grant trading permission for your account to another party.
Available to: Traders (own account); organization administrators (any account in their organization)
Environments: Demo, Live
Rate Limit: 20 requests per hour, 2-second back-off, counts failed requests only
Note: On Demo, partner organizations can grant a trading permission directly with createTradingPermission.
Ask for another user to be given trading permission on an account. Pass the accountId, the other user’s ctaEmail, and their ctaContact. ctaContact must be the user’s first and last name separated by a space, exactly as in their contact information. When the request succeeds, the response returns the new tradingPermission.
When the other user is in your organization, has given you consent to grant them trading permissions, or is set to accept trading permissions automatically, the permission is accepted right away (Approved on Demo, Accepted on Live). Otherwise it starts as Requested.
Only an Approved permission gives the other user access to the account. A Requested or Accepted permission still needs to be reviewed and approved first.
Common Failure Scenarios
- The
ctaEmailandctaContactdon’t identify a trader who can accept this permission. This returnsHTTP 200with"Incorrect contact information"inerrorText. If you belong to an organization, the server first looks for the one user in your organization with that email. If there isn’t exactly one, it looks for exactly one user anywhere whose email matches, and that user must have consented to trading permissions from you. Either way, the user must be a trader whose first and last name, separated by a space, exactly matchctaContact, including capitalization. On Demo, the server retries the lookup for about 11 seconds before returning this error. - The other user already has a trading permission for this account that hasn’t been declined or revoked. This returns
HTTP 200with"Duplicate request"inerrorText, along with the existing permission. - The other user has reached their limit of permissioned accounts, or the grant would exceed a subaccount limit. These return
HTTP 200with the limit message inerrorText. - The caller doesn’t own the account and isn’t an organization administrator. This returns
HTTP 401with"mustBeOrganizationAdmin". - No account matches
accountId, or the caller can’t access it. Both returnHTTP 404with an empty body. accountIdisn’t greater than 0,ctaContactorctaEmailis empty or longer than 64 characters, orctaEmailisn’t a valid email address. These returnHTTP 400.- The caller’s user type, or the API key’s permissions, don’t include full access to the
Usersresource. This returnsHTTP 401with"Access is denied".
This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.
Error Messages
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed