Ctrl+K

Add user to enterprise

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

Path Parameters

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

Request Body

One of
permissionOne of
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
videoIdUser boolean
invite boolean
username string <email>required
The username of a user that should be added to the enteprrise

200 Response

202 Response

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}$
walletType string
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
updatedAt string <date-time>
The date when the approval was last updated (any update, not just processing)
keyCurve string
The key curve of the coin attached to this pending approval
Allowed values: secp256k1 ed25519 bls12_381
info object required
Information about the pending approval
type string required
Allowed values: userChangeRequest transactionRequest transactionRequestFull policyRuleRequest updateApprovalsRequiredRequest updateEnterpriseRequest updateOrganizationRequest genericRequest enterpriseInviteRequest
userChangeRequest object
transactionRequest object
transactionRequestFull object
policyRuleRequest object
updateApprovalsRequiredRequest object
updateEnterpriseRequest object
updateOrganizationRequest object
genericRequest object
enterpriseInviteRequest object
stateOne ofrequired
The state of the pending approval
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification pendingLivenessVerification pendingManualTrustReview
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
address string required
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label string required
The label
walletLabel string
The wallet label
resolvers array[object]
Resolvers for the pending approval
autoApproved boolean
Whether the resolution was auto approved
date string <date-time>
The date of resolution
resolutionAction string
Action taken during resolution
Allowed values: approve reject skip fail
resolutionMemo string
Memo regarding the resolution
resolutionType string required
The type of resolution
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification pendingLivenessVerification pendingManualTrustReview
user string
The user who resolved the approval
videoApprover string
The approver of the video resolution
videoException string
Exception details for the video
videoLink string
Link to the resolution video
approvers array[string]
List of approvers
singleRunResults array[object]
Results from single run checks
ruleId string
The rule ID
triggered boolean
Whether the rule was triggered
txRequestId string <uuid>
Transaction request ID
Example: 123e4567-e89b-12d3-a456-426614174000
videoId object
ID for the video related to the approval
date string <date-time>
The date of the video ID
user string
The user associated with the video ID
videoApprover string
The approver of the video
videoException string
The exception related to the video
videoLink string
The link to the video
version number
Version of the pending approval
groupApprovalRequirement object
Requirements for providing group approval.
items array[object] required
operator string required
Allowed values: and or
policyEvaluationId string
ID for the policy evaluation
actions array[object]
List of actions taken
approvers array[string]
The approvers of the action
id string required
The ID of the action
name string required
The name of the action
operator string
The operator of the action
Allowed values: AND OR
parameters object required
The parameters of the action
resolvers array[object]
The resolvers of the action
status string required
The status of the action
Allowed values: SKIPPED PENDING NOT_NEEDED COMPLETE CANCELLED FAILED
resolutionOrder array[object]
Order of resolution
actions array[string] required
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
freeze object
The freeze state
actions array[object]
state string
Allowed values: frozen unFrozen
associatedInquiries array[object]
Associated inquiries
inquiryId string required
inquiryStatus string required
Allowed values: completed failed
inquirySubType string required
Allowed value: withdrawalLivenessCheck
inquiryType string required
Allowed value: livenessCheck

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