Ctrl+K

Internal get enterprise

get/api/v2/internal/enterprise/summary

Shows an admin summary (extended enterprise information) for an enterprise

Query Parameters

  • excludeWalletCountsbooleanDefault: false
    Pass this if you don't need wallet counts by coin
  • includeDeletedbooleanDefault: true
    Pass this if you want to return deleted wallets
  • enterpriseIdsarray[string]Default: []
    List of enterprise ids to fetch, min length 0, max length 500 if no enterpriseIds are provided, all enterprises will be returned (up to the limit)
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • limitstring<number>Default: 25
    Limit the number of search results.
    Minimum: >= 0
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

enterprises array[object] required
Admin enterprise JSON for summary endpoints - with organization as full object
organization object
The parent organization (customer) to which the enterprise belongs
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
name string required
Example: Small Company
bitgoOrg string required
BitGo Organization related to this entity
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
kycState string required
Allowed values: unverified approved rejected pending qrscanned inreview flagged flagged_retry_allowed
legalIdentifiers object required
type string required
latestSAVersionSigned number required
Example: 0
travelRule boolean required
productLicenses array[string] required
canAccessBorrowing boolean required
whether the enterprise has the licence for BitGo Prime Borrowing
canAccessLending boolean required
whether the enterprise has the licence for BitGo Prime Lending
canAccessSettlement boolean required
whether the enterprise has the licence to utilize settlement functionality
canAccessTrading boolean required
whether the enterprise has the licence to access BitGo Trading
canCreateColdWallet boolean required
whether the enterprise has the license to create cold wallets
canCreateHotWallet boolean required
whether the enterprise has the license to create hot wallets
canCreateCustodialWallet boolean required
whether the enterprise has the license to create custodial wallets
canCreateOffchainWallet boolean required
whether the enterprise has the license to create trading accounts
oneTimeFees array[string] required
upfrontPaymentStatus string required
ethAlwaysUseHop boolean required
Always use hop address for ETH transactions
usersViewAllWallets boolean required
All users on the enterprise can view all enterprise wallets, even if they are not viewers on the wallet itself
Example: true
videoIdWaived boolean required
Whether the customer has waived the need for Video ID on low risk withdrawals.
Example: false
additionalEnterpriseInfo object
tradeOnboardingAgreement object
Who & when the MPA license was ack'd
stakingServicesAgreement object
For users doing self-service onboarding, they just need to click a checkbox to agree to the terms. we will track who & when that happened on a feature-by-feature basis.
custodyServicesAgreement object
For users doing self-service onboarding, they just need to click a checkbox to agree to the terms. we will track who & when that happened on a feature-by-feature basis.
stablecoinAgreement array[object]
Stablecoin agreement schema for enterprise users.
accountType string
Indicates which type of KYC process the enterprise has to complete
Allowed values: individual entity
businessModel string
Allowed values: bitgoAsAService cryptoAsAServiceParent cryptoAsAServiceChild
salesforceAccountId string
Opportunity ID from Salesforce
salesforceOpportunityId string
opportunityName string
Opportunity Name from Salesforce
salesEmail string
cheetahAccountId string
CheetahAccountID is the unique ID for a BitGo Trust enterprise in Cheetah, which is the accounting system used by Trust.
primaryContact string
The Id of the User who is the primary contact
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
emergencyPhone string
Phone number for emergencies
Example: +11234567890
pricingPlan string
The pricing plan of the enterprise
approvalsRequired number
How many Enterprise Admins are required for action to fire
Example: 1
mutablePolicyWindow number
Time in seconds after which policies on this Enterprise cannot be updated
Example: 172800
freeze object
bitgoEthKey string
The public portion of the ethererum key generated for the enterprise fee address
ethFeeAddress string
The eth fee address used to pay for network transaction fees of this enterprise
walletLimit dictionary<string, number>
preferredUi string
The UI that this enterprise prefers to use
Allowed values: bg23
custodialWalletLimit
dictionary<string, number> or null
featureFlags array[string]
labels array[string]
publicLabels array[string]
Subset of labels that are OK to return back to client in GetEnterpriseResponse
licenses array[string]
New licences that are not stored as flags. Tax requires Portfolio Professional or Institutional
ellipticId string
Identifier for environment variables for a customer's Elliptic API credentials
ellipticHotWallets boolean
Hot wallet transactions on this enterprise are monitored in Elliptic
vaspId string
bitgoVaspId string
coinSpecific object
walletCounts object
Number of wallets per coin
activePricingType
object or null
source string
Allowed values: bitcoinBuilder ftx ftx-retail ftx-bahamas ftx-bahamas-retail sofi sofiDocuSignPendingDeprecation bitcoinWell lucid wlf walrus mtgox landingPageReferral caas test
totalWalletsCount number
The total number of wallets in the enterprise
Example: 1
internal object
distributedCustody object
migratedToNewPolicyService boolean
Whether the enterprise has been migrated to the new policy service
videoIdUsers array[object]
IDs of users on the enterprise that are approved for custodial video ID
sourceConfig array[object]
Array to store configs, upon which certain actions are taken, per source
videoIdRequired boolean
Check for video ID Users
contract object
Contract information
referralCode string
Referral code
oauthSettingOne of
oauth setting of the enterprise *
optOutOfPoints boolean
Opt Out of Points System Flag
requestedBitgoOrg string
Requested BitGo Org
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
requestedProducts array[string]
Requested Products
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
requestedBitgoProducts array[string]
Requested BitGo Products
Allowed values: Instant Fee Wallets Go Account Settlement Tax Trade API Margin Trading Elliptic CryptoCompare MetaMask Custody Borrowing Lending DeFi Cold Self-Custody Go Network Staking Trade Hot Self-Custody Escrow Escrow - Triparty Distributed Custody Advanced Wallets Stablecoins Loans against Go Account ACH Debits Go Lightning
isContractedClient boolean
True, if the enterprise has been onboarded by Salesforce
billableUserCount number required
Number of billable users
billableUsers array[object] required
Billable users on the enterprise
Max items: <= 500 items
incomplete boolean required
True, if the enterprise has more than 500 users
members array[object] required
Enterprise members (users without admin privileges)
Max items: <= 500 items
owners array[object] required
Enterprise owners (users with admin privileges)
primaryContactEmail string required
hasOfc boolean required
shardKey string required
Field used to shard mongo. Currently used to segregate PII data for the Korea org
Allowed values: bitgoKorea unset
admin object
isBitGoControlledEnterprise boolean
True if the enterprise is operated by a BitGo entity for its own purposes. BitGo can initiate, authorize, or reverse transactions on associated wallets/assets without third-party authorization.
isBitGoTestEnterprise boolean
True if the enterprise was created by a BitGo employee for product testing. Test assets are expensed to BitGo.
financialReportingEntity string
The BitGo entity controlling the assets, whose balance sheet the assets should be reported on. Only present if the enterprise is BitGo controlled.
Allowed values: BitGo Holdings, Inc. BitGo Ecosystem Holdings LLC BitGo Financial LLC BitGo Holdings EMEA Ltd BitGo Custody MENA FZE (UAE) BitGo Europe Denmark BitGo Europe GmbH BitGo GmbH BitGo Hong Kong Ltd BitGo MENA FZE (UAE) BitGo Korea, Inc. BitGo New York Trust Company LLC BitGo Prime BitGo Prime UK Ltd BitGo Technologies LLC BitGo Technologies India Private Limited BitGo Trust Co. Inc BitGo, Inc BitGo Canada BitGo Europe LTD BitGo India Private Limited BitGo Japan KK BitGo Singapore Pte. LTD BitGo Taiwan Brassica Technologies Inc. Brassica Services LLC Brassica Trust Company LLC Brassica Ventures LLC Republic Asia Advisors Pte Go Technologies Ltd (Cayman Islands) HeightZero
purpose string
The purpose of the enterprise. Optional field that is only present when the enterprise is BitGo controlled.
useHsmRegionalRouting boolean

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