GET

Get user

Returns the associated user

Path Params

id string required

The user ID, email address, or me for the currently authenticated user

matches ^[0-9a-f]{32}$

Query Params

orgId string

The organization ID by which to filter the user's enterprises.
maxEnterprises integer

Specifies the maximum number of enterprises to return. An organization ID must be provided. The maximum limit is 50 enterprises.

Responses

200

Response Body

object

user object required
user object
- id string
  
  matches ^[0-9a-f]{32}$
- isActive boolean
- isFrozen boolean
- freezeReason string
- name object
  name object
  - first string
  - full string
  - last string
- username string email
- email object
  email object
  - email string email
  - verified boolean
- phone object
  phone object
  - phone string
  - verified boolean
- country string
- state string
- kycStatus string enum
  
  user's overall KYC status
  
  approvedpendingrejectedunverified
kycStatus string enum

The user's KYC status. Only returned when the requester is an org admin viewing another user.

approvedpendingrejectedunverified

400

Bad Request

Response Body

ONE OF

error string required

Human-readable error message
requestId string required

Client request id
context object

Properties that apply to a specific error name
name string required

Error code

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidUserId

404

Not Found

No response body

curl --request GET \ --url 'https://app.bitgo-test.com/api/v2/user/id&orgId=string&maxEnterprises=0' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v2/user/id&orgId=string&maxEnterprises=0'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; 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/id&orgId=string&maxEnterprises=0") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v2/user/id&orgId=string&maxEnterprises=0', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/user/id&orgId=string&maxEnterprises=0" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "user": { "id": "59cd72485007a239fb00282ed480da1f", "isActive": true, "isFrozen": true, "freezeReason": "Frozen due to suspicious activity", "name": { "first": "Jane", "full": "Jane Doe", "last": "Doe" }, "username": "user@example.com", "email": { "email": "user@example.com", "verified": true }, "phone": { "phone": "408-718-6885", "verified": true }, "country": "USA", "state": "New York", "kycStatus": "approved" }, "kycStatus": "approved" }