Ctrl+K

Internal institutional signup

post/api/v2/internal/user/institutionalSignup

Create a new institutional user and enterprise through internal API.

Request Body

email string required
The email address of the new user to be created.
Min length: >= 1 characters
password string required
The password for the new user.
Min length: >= 1 characters
accountType string required
The account type for the enterprise.
Allowed values: individual entity
salesforceBitgoOrg string required
The BitGo organization for the enterprise.
Allowed values: BitGo Inc BitGo Trust Company Inc BitGo NY Trust BitGo Deutschland GMBH BitGo GmbH BitGo Prime BitGo Singapore Pte. Ltd BitGo Europe GmbH BitGo Europe ApS BitGo Custody MENA FZE
salesforceAccountId string required
The Salesforce account ID.
Min length: >= 1 characters
salesforceOpportunityId string required
The Salesforce opportunity ID.
Min length: >= 1 characters
opportunityName string
The opportunity name.
Min length: >= 1 characters
salesEmail string
The sales email contact.
Min length: >= 1 characters
products array[string]
The products/licenses for the enterprise.
Allowed values: BitGo MMI BitGo Qualified Custody BitGo Qualified Custody & Hot Wallet Borrowing Borrowing / Lending Lending NFTs Self Custody Go Network: Off Exchange Settlement Staking Trade Transactional / Hot Wallet Wrapped Asset Services Escrow Escrow - Triparty Distributed Custody Wallet Token Management (HZ) Platform Integration (B2B2C) BitGo Wealth Management (HZ) BitGo Concierge Coincover Referral Go Network: Fiat currency Settlement Fiat Currency Custody Excess Insurance Setup Lightning Liquidity Provider Alliance Agreement BitGo Custody BitGo MMI (Inc) Coincover Referral (Inc) Custom Project NFTs (Inc) Other (Inc) Partial Signature Portfolio & Tax Professional Services Setup (Inc) Staking (Inc) Platform Integration (B2B2C) (Inc) OTC Trading
labels array[string]
The labels for the enterprise.
hash string required
The hash for request validation.
Min length: >= 1 characters
source string
The source of the signup.
Min length: >= 1 characters

200 Response

user object required
username string required
userID string required
enterprise object required
id string required
name string required

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

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