How to get information about the current API user

Overview

Use User API to get information about the current API user, available accounts, and account permissions.

This method is useful when you need to understand which accounts can be used by the current API key.

Field	Type	Required	Description
timestamp	number	Yes	Current Unix UTC timestamp in milliseconds. The value must not be less than 3 minutes in the past or greater than 3 minutes in the future.

{
  "timestamp": 1761650432438
}

Field	Type	Description
userFullInfo	object	Current API user details.
permissions	array	Permission groups by account.
availableAccounts	array	Accounts available to the user.

Field	Type	Description
id	string	User ID.
username	string	Username.
companyId	string	Company ID.
companyName	string	Company name.
active	boolean	Shows whether the user is active.
blocked	boolean	Shows whether the user is blocked.
roles	array	User roles.

Field	Type	Description
account	string	Account ID.
name	string	Account name.

Field	Type	Description
accountId	string	Account ID.
accountName	string	Account name.
permissionGroups	array	Permission groups assigned to the user for the account.

Case	Recommendation
API key is used by several accounts	Use `availableAccounts` to choose a valid `account` value for account-scoped requests.
User cannot access account data	Check `permissions` and account availability before creating payment, payout, or report requests.
Access should be displayed in UI	Show only accounts returned in `availableAccounts`.

Document	Link
Account balances	How to get balances for a specific account
User API reference	User API