Ctrl+K

Remove user from enterprise

delete/api/v2/enterprise/{enterpriseId}/user

Path Parameters

  • enterpriseIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

username string <email>required

202 Response

pendingApprovals array[object]
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
A cryptocurrency or token ticker symbol.
Example: btc
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
wallets array[string]
The wallets of the pending approval
Example: 59cd72485007a239fb00282ed480da1f
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organizationName string
The organization name
bitgoOrg string
The BitGo organization
creator string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>required
The creation date of the pending approval
approvedDate string <date-time>
The date when the approval was granted
info object required
Information about the pending approval
stateOne ofrequired
The state of the pending approval
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification pendingLivenessVerification
scope string required
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet organization
userIds array[string]
All the Users who should see this Pending Approval
approvalsRequired number
Minimum: >= 1
Example: 1
walletLabel string
Label for the wallet
addressLabels array[object]
Address labels of recipients in this Pending Approval
resolvers array[object]
Resolvers for the pending approval
approvers array[string]
List of approvers
singleRunResults array[object]
Results from single run checks
txRequestId string <uuid>
Transaction request ID
Example: 123e4567-e89b-12d3-a456-426614174000
videoId object
ID for the video related to the approval
version number
Version of the pending approval
groupApprovalRequirement object
Requirements for providing group approval.
policyEvaluationId string
ID for the policy evaluation
actions array[object]
List of actions taken
resolutionOrder array[object]
Order of resolution
useLegacyPolicyEngine boolean
Flag to use legacy policy engine
videoCallId string
ID for the video call
lastUpdated string <date-time>
The last date the approval was processing

400 Response

One of
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

404 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