The permissions granted by this access token.
- `all` - Access all actions in the test environment.
- `crypto_compare` - Call CryptoCompare API.
- `enterprise_manage_all` - Manage users and settings for any enterprise to which the user belongs.
- `enterprise_view_all` - View any enterprise to which the user belongs.
- `metamask_institutional` - [DEPRECATED] Enables using BitGo wallets in the MetaMask Institutional extension.
- `openid` - Verify your BitGo user ID using OpenID Connect.
- `pending_approval_update` - Approve or reject pending actions that require approval to proceed.
- `portfolio_view` - [DEPRECATED] Call the Portfolio API.
- `profile` - View your BitGo Profile.
- `settlement_network_read` - View your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners.
- `settlement_network_write` - Update your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners.
- `trade_trade` - Initiate trades.
- `trade_view` - View trades.
- `trade_fix` - Access the Trade FIX API gateway.
- `wallet_approve` - Approve policies and transactions for a wallet where the user is a wallet admin.
- `wallet_approve_all` - Approve transactions for any wallet where the user is a wallet admin within any enterprise to which the user belongs.
- `wallet_approve_enterprise` - Approve transactions for any wallet where the user is a wallet admin within a single enterprise.
- `wallet_create` - Create wallets.
- `wallet_edit` - Edit comments on a transfer.
- `wallet_edit_all` - Edit comments on all transfers within multiple enterprises.
- `wallet_edit_enterprise` - [DEPRECATED] Edit comments on all transfers within a single enterprise.
- `wallet_freeze` - Freeze a wallet.
- `wallet_freeze_all` - Freeze any wallet within any enterprises to which the user belongs.
- `wallet_manage` - Manage settings for a wallet where the user is a wallet admin.
- `wallet_manage_all` - Manage settings for any wallet where the user is a wallet admin within any enterprise to which the user belongs.
- `wallet_manage_enterprise` - Manage settings for any wallet where the user is a wallet admin within a single enterprise.
- `wallet_spend` - Initiate transactions from a wallet.
- `wallet_spend_all` - Initiate transactions from any wallet within any enterprise to which the user belongs.
- `wallet_spend_enterprise` - Initiate transactions from any wallet within a single enterprise.
- `wallet_stake` - Initiate staking transactions from a wallet.
- `wallet_stake_all` - Initiate staking transactions from any wallet within any enterprise to which the user belongs.
- `wallet_view` - View a wallet.
- `wallet_view_all` - View any wallet within any enterprise to which the user belongs.
- `wallet_view_enterprise` - View any wallet within a single enterprise.
Restricts the access token to use only from the provided IP addresses. Required for access tokens in the production environment. Not required for access tokens in the test environment.
enterprisestring
The enterprise ID that the user belongs to.
spendingLimitsarray[object]
coinstringrequired
A cryptocurrency symbol or token ticker symbol
Example: btc
maxLimitboolean
txValueLimitOne ofrequired
allErc20TokensLimitobject
enabledboolean
maxLimitboolean
txValueLimitOne of
accessTokenTemplateIdstring
ID of the AccessTokenTemplate to use as defaults for this token.
Template fields act as defaults — they are used when the corresponding field is absent from the
request body. Any value you provide in the request, including an empty array, takes precedence.
For example, if the template has `scope: ['spend', 'transfer']` and you send `scope: ['read']`,
the created token will have `scope: ['read']`. If you omit `scope` entirely, the token gets
`scope: ['spend', 'transfer']` from the template.
200 Response
idstringrequired
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isExtensiblebooleanrequired
bitgoAdminPermissionsarray[string]
clientstring
createdstring<date-time>
enterprisestring
expiresstring<date-time>
extensionAddressstring
ipstring<ipv4>
IP address of the client that requested this access token
Example: 127.0.0.1
ipRestrictarray[string]
IP addresses or CIDR block of clients that are allowed to use this token