Ctrl+K

Unlock session

post/api/v2/user/unlock

Unlocks the current user session, enabling operations that require an unlocked token, such as sending a transaction. Call this endpoint if an API returns a "401" response with the "needsUnlock" body parameter set to "true".

Note: Unlocking a token with spending limits, removes all spending limits from the token.

Request Body

duration integer
Number of seconds that the session will stay unlocked
Minimum: >= 1
Maximum: <= 3600
Default: 600
otp string
Second factor authentication token
Example: 123456
javascript
1
2
3
bitgo.unlock({ otp: '0000000' }).then(function (unlockResponse) {
  console.dir(unlockResponse);
});

200 Response

session object
created string <date-time>required
expires string <date-time>required
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
ip string <ipv4>
IP address of the client that requested this access token
Example: 127.0.0.1
ipRestrict array[string]
IP addresses of clients that are allowed to use this token
origin string required
BitGo environment that issued this token
Example: test.bitgo.com
scope array[string] required
Session permissions
Example: ["crypto_compare","user_manage","openid","profile","wallet_create","wallet_manage_all","wallet_approve_all","wallet_spend_all","wallet_edit_all","wallet_view_all"]
unlock object
The Unlock object, returned if this session is currently unlocked.
user string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$