Ctrl+K

List enterprises

get/api/v2/admin/enterprise

Search for enterprises. At least one parameter is required

Query Parameters

  • bitgoOrgstring
  • idarray[string]
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • licensearray[undefined]
  • pricingPlanstring
    Exact search for a pricing plan
  • searchstring
    Fuzzy search for the enterprise name or pricing plan
  • limitnumber
    Limit the number of search results. Default 100
    Minimum: >= 0
    Maximum: <= 10000

200 Response

enterprises array[object]
accountType string
Indicates which type of KYC process the enterprise has to complete
Allowed values: individual entity
additionalEnterpriseInfo object
admin object
approvedVideoIdUsers array[string]
IDs of users on the enterprise that are approved for custodial video ID
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired integer
How many Enterprise Admins are required for action to fire
Example: 1
bitgoEthKey string
The public portion of the ethererum key generated for the enterprise fee address
bitgoOrg string
BitGo Organization related to this entity
Allowed values: BitGo Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo India
canAccessBorrowing boolean
whether the enterprise has the licence for BitGo Prime Borrowing
canAccessLending boolean
whether the enterprise has the licence for BitGo Prime Lending
canAccessSettlement boolean
whether the enterprise has the licence to utilize settlement functionality
canAccessTrading boolean
whether the enterprise has the licence to access BitGo Trading
canCreateColdWallet boolean
whether the enterprise has the license to create cold wallets
canCreateCustodialWallets boolean
whether the enterprise has the license to create custodial wallets
canCreateHotWallet boolean
whether the enterprise has the license to create hot wallets
canCreateOffchainWallet boolean
whether the enterprise has the license to create trading accounts
contract object
custodyServicesAgreement object
Information about the signed custody services agreement
emergencyPhone string
Phone number for emergencies
Example: +11234567890
ethFeeAddress string
The eth fee address used to pay for network transaction fees of this enterprise
freeze object
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
kycState string
Allowed values: unverified approved rejected
latestSAVersionSigned integer
Example: 0
licenses string
Allowed values: bitgoNetwork marginTrading mtGox portfolioAPI portfolioBasic portfolioProfessional portfolioInstitutional tax tradeAPI staking metaMaskInstitutional cryptoCompare elliptic instantFeeHotWallet bitgoTrustAsKrs escrow distributedCustodyWallet selfCustodyLightningWallet custodyLightningWallet advancedWallets
mutablePolicyWindow integer
Time in seconds after which policies on this Enterprise cannot be updated
Example: 172800
name string
Example: Small Company
pricingPlan string
The pricing plan of the enterprise
pricingTypes array[object]
activePricingType object
kits array[object]
activeKits array[object]
primaryContact string
The Id of the User who is the primary contact
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
preferredUi string
The UI that this enterprise prefers to use
Allowed value: bg23
totalWalletsCount integer
The total number of wallets in the enterprise
Example: 1
usersViewAllWallets boolean
All users on the enterprise can view all enterprise wallets, even if they are not viewers on the wallet itself
Example: true
videoIdWaived boolean
Whether the customer has waived the need for Video ID on low risk withdrawals.
Example: true
tags array[string]
In what way(s) the user is associated with the enterprise
Allowed values: user wallet pending walletV2 pendingV2

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code