Ctrl+K

Admin User Update Request

put/api/v2/admin/user/{userId}

Path Parameters

  • userIdstringRequired
    The ID of the user

Request Body

otp string required
One-time password for the update request
Min length: >= 1 characters
Example: 000000
bitgoEmployee boolean
Toggles the user's bitgoEmployee state. Requires updateBitGoEmployee admin permission.
passportRequired boolean
Only allows passport for the user KYC documents step.
videoLink string
Link to the onboarding Video ID recording with the customer. Required for updating Video ID.
Min length: >= 1 characters
Example: https://drive.google.com/file/...
videoDate string <date-time>
Date when the Video ID call was done. Required for updating Video ID.
enterpriseId string
ID of the associated enterprise
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organizationId string
ID of the associated organization
Min length: >= 1 characters
label string
Label to apply to Video ID.
Min length: >= 1 characters
deleteVideoId boolean
Delete the specified videoId
sourceVerificationRequired boolean
Indicates if source verification is required
sourceVerificationRequiredForReadOnlyAccess boolean
Indicates if source verification is required for read-only access

200 Response

bitgoAdminRoles array[string] required
The roles the user has in BitGo Admin
identity object required
The user's identity information
kyc object required
verified boolean
Whether the user is verified
shardKey string required
Field used to shard mongo. Currently used to segregate PII data for the Korea org
Allowed values: bitgoKorea unset
pricingPlan string
The pricing plan the user is on
clientSettings object
custom flags set by the UI
agreements object required
The agreements the user has accepted
patriotAct number required
termsOfUse number required
patriotActAcceptanceDate string <date-time>
termsOfUseAcceptanceDate string <date-time>
allowedCoins array[string] required
The coins the user is allowed to use
bitgoEmployee boolean required
Whether the user is a BitGo employee
currency object required
The user's preferred currency
bitcoinUnit string required
currency string required
disableReset2FA boolean required
Whether the user has disabled 2FA reset
organizations array[object] required
The organizations the user is a member of
permissions array[string] required
Allowed value: admin
role string required
Allowed values: serviceUser admin member customer
Example: admin
id string
name string
featureFlags array[string] required
Any feature flags the user has enabled
forceResetPassword boolean required
Whether the user has forced a password reset
otpDevices array[object] required
The user's devices that can be used for OTP authentication
createDate string <date-time>required
id string required
backupPhone string
label string
lastValidatedDate string <date-time>
phone string
registeredKey object
type string
Allowed values: authy totp u2f webauthn yubikey
verified boolean
scopes array[string]
Allowed value: wallet_hot
extensions dictionary<string, boolean>
prfSalt string
isPasskey boolean
phone object required
The user's phone number
phone
string or null
required
Example: 408-718-6885
verified boolean required
Example: true
timezone string required
The user's timezone
apps
The apps the user has access to
country string
The country of the user
Example: USA
ecdhKeychain
string or null
The user's ECDH keychain
isActive boolean
Whether the user is active
isFrozen boolean
Whether the user is frozen
freezeReason string
The reason the user is frozen if they are frozen
Example: Frozen due to suspicious activity
freeze object
Freeze object that will hold the start time and expiration time of a user's freeze. By default the freeze is infinite, and this field will eventually override the isFrozen boolean field
time string <date-time>
expires string <date-time>
lastLogin string <date-time>
The last login time of the user
locale string
The user's locale
pgpKey string
The user's PGP key
rateLimits
The rate limits applied to the user
referrer object
The referrer of the user
campaign
string or null
source
string or null
signupDomain string
The signup domain of the user
state string
The state of the user
Example: New York
sourceVerificationRequired boolean
Whether source verification is required for the user
sourceVerificationRequiredForReadOnlyAccess boolean
Whether source verification is required for read-only access
recoveryCodeSet object
The recovery code set for the user
id string required
The ID of the recovery code set
allCodesUsed boolean required
Whether all recovery codes have been used
createTime string
passwordUpdatedAt string <date-time>
id string required
The unique identifier for the user
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
username string <email>required
The username of the user
Example: user@email.com
name object required
The name of the user
first string required
Example: Jane
full string required
Example: Jane Doe
last string required
Example: Doe
enterprises array[object] required
The enterprise(s) the user is a member of
permissions array[string] required
This type represents the permissions that can be assigned to a user when adding them to an enterprise 1. 'admin': Add/remove users, Create wallets, Manage enterprise policies, Add Bank Accounts, Receive invitations to wallets 2. 'auditor': View audit logs across the enterprise, Receive invitations to wallets
Allowed values: admin auditor
id string
beneficialOwner boolean
primaryContact string
kycState string
Allowed values: unverified approved rejected pending qrscanned inreview flagged flagged_retry_allowed
bitgoOrg string
name string
email object required
The email address of the user
email string <email>required
Example: user@email.com
verified boolean required
Example: true

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id