Ctrl+K

Verify User

post/api/v2/user/verify

Route to verify user

Request Body

email string required
The email of the user to be verified
Min length: >= 1 characters
accountType string required
The type of the account
Allowed values: individual entity
salesforceBitgoOrg string required
The Salesforce BitGo organization
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 Salesforce opportunity name
Min length: >= 1 characters
salesEmail string
The email of the sales representative
Min length: >= 1 characters
products array[string]
The products associated with the user
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 associated with the user
source string
The source used for tagging customer-specific enterprises
Min length: >= 1 characters
hash string required
The hash for verification
Min length: >= 1 characters

200 Response

user object required
id string required
The ID of the user
Min length: >= 1 characters
username string required
The username of the user
Min length: >= 1 characters

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