POST

Unlock session

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.

Body Params

object

duration integer

Number of seconds that the session will stay unlocked

>= 1 · <= 3600

Defaults to 600
otp string

Second factor authentication token

Responses

200

Response Body

object

session object
session object
- created string date-time required
- expires string date-time required
- id string required
  
  matches ^[0-9a-f]{32}$
- ip string ipv4
  
  IP address of the client that requested this access token
- ipRestrict array of strings
  
  IP addresses or CIDR block of clients that are allowed to use this token
- origin string required
  
  BitGo environment that issued this token
- scope array of strings required
  
  Session permissions
- unlock object
  
  The Unlock object, returned if this session is currently unlocked.
  unlock object
  - time string date-time
  - expires string date-time
  - txCount integer
  - txValue integer
  - txValueLimit number
  - spendingLimits map of objects
    
    spendingLimits object
    
    <key> object
    
    value object
    
    txCount integer
    
    txValue integer
    
    txValueLimit number
- user string required
  
  matches ^[0-9a-f]{32}$

curl --request POST \ --url 'https://app.bitgo-test.com/api/v2/user/unlock' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"duration":600,"otp":"123456"}'

const url = 'https://app.bitgo-test.com/api/v2/user/unlock'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"duration":600,"otp":"123456"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/user/unlock") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"duration":600,"otp":"123456"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/v2/user/unlock', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"duration":600,"otp":"123456"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/user/unlock" payload = {,"duration":600,"otp":"123456"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)

{ "session": { "created": "string", "expires": "string", "id": "59cd72485007a239fb00282ed480da1f", "ip": "127.0.0.1", "ipRestrict": [ "string" ], "origin": "test.bitgo.com", "scope": [ "crypto_compare", "user_manage", "openid", "profile", "wallet_create", "wallet_manage_all", "wallet_approve_all", "wallet_spend_all", "wallet_edit_all", "wallet_view_all" ], "unlock": { "time": "string", "expires": "string", "txCount": 0, "txValue": 0, "txValueLimit": 0, "spendingLimits": { "btc": { "txCount": 1, "txValue": 0, "txValueLimit": 100000000 }, "eth": { "txCount": 1, "txValue": 0, "txValueLimit": 50000000000 } } }, "user": "59cd72485007a239fb00282ed480da1f" } }