Partner's Personal Access Tokens
- Personal Access Token
*
Trading is risky. Your capital is at risk.
A Personal Access Token is a secure credential that allows IB partners to access backend APIs—just like they previously did when interfacing directly with their IB portals. This token is essential for retrieving data related to:
- Your clients
- Your sub-IBs
- Your rebates
Follow these steps to obtain your Personal Access Token:
- Log in to the Partner Portal.
- Click on the profile icon in the top-right corner of the screen.
- Under Personal Details, locate the Personal Access Token section.
- Click the "Add" icon to generate your token.
Once generated, include the token in the Authorization header of your API requests:
{"PRIVATE-TOKEN": token}
If the user requests the API without a header / with a non-existent token / with an expired or revoked token - the API should return Status Code 401 and an error in JSON format.
For example:
{ "error": "The token for API authorization has expired. Please create a new token in your partner portal."