Ctrl+K

Get enterprise

get/api/v2/enterprise/{enterpriseId}

Path Parameters

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

Query Parameters

  • excludeV1Walletsboolean
    True, if excluding "wallets" field containing v1 wallet addresses from the enterprise
  • expandTotalWalletsCountboolean
    True, if returning the total number of wallets for this enterprise

200 Response

wallets array[string] required
tags array[object] required
name string required
id string required
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
name string required
Example: Small Company
additionalEnterpriseInfo object required
contact object
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 Sister Trust 1 BitGo Inc
kycState string required
Allowed values: unverified approved rejected pending
legalIdentifiers object required
legalPersonNameIdentifierType string required
Allowed value: LEGL
legalPersonName string
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
tradeOnboardingAgreement object
Who & when the MPA license was ack'd
user string required
date string <date-time>required
ip string
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.
user string required
date string <date-time>required
ip string
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.
user string required
date string <date-time>required
ip string
accountType string
Indicates which type of KYC process the enterprise has to complete
Allowed values: individual entity
businessModel string
Allowed value: bitgoAsAService
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
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organizationId string
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
timeOne of
When the freeze started
expiresOne of
When the freeze will end
reason string
The reason the entity was frozen
frozenBy string
The user that froze the entity
unFrozenBy string
The user that unfroze the entity
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>
number
preferredUi string
The UI that this enterprise prefers to use
Allowed values: bg23
custodialWalletLimit
dictionary<string, number> or null
number
featureFlags array[string]
labels array[string]
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
enterpriseWallets dictionary<string, number> required
activePricingType
object or null
name string required
Allowed values: starter growth employee FTX Retail FTX Institutional
startDateOne ofrequired
ISO 8601 Datetime (example at https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). If present, will use as the start date of a new auditable item. If not present, will use the current date to create a new auditable item. Start date is inclusive, i.e. we will start billing/functionality at this instant and afterwards.
startReason string required
An optional note describing the reason the auditable item was added/created.
id string
Unique identifier for the date range.
endDateOne of
ISO 8601 Datetime (example at https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). If present, will use as the end date of a new auditable item. If not present, we will set the endDate to null, and we will assume an indefinite range. endDate is exclusive, i.e. we will end billing/functionality up to but not at this particular time.
endReason string
An optional note describing the reason the auditable item was ended.
source string
Allowed values: bitcoinBuilder ftx ftx-retail ftx-bahamas ftx-bahamas-retail sofi bitcoinWell lucid
totalWalletsCount number
The total number of wallets in the enterprise
Example: 1
internal object
migratedToNewPolicyService
boolean or null
required
Whether the enterprise has been migrated to the new policy service
policiesLocked boolean required
distributedCustody object
signingBitgoOrg string required
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Sister Trust 1 BitGo Inc
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
email string required
The email of the user
Min length: >= 1 characters
userId string required
The user ID
Min length: >= 1 characters
inviter string required
The inviter of the user
Min length: >= 1 characters
state string required
The state of the user
Allowed values: awaitingApproval awaitingAcceptance pendingSchedule pendingInitialId underReview approved rejected archived
videoCallId string
The user's video call ID
approvalDate string
The date the user was approved
archivedDate string
The date the user was archived
pendingApprovalId string
The ID if the user is pending approval
videoLink string
The user's video link
enterpriseId string
EnterpriseId of enterprise this video users belongs to
enterpriseName string
EnterpriseName of enterprise this video users belongs to
sourceConfig array[object]
Array to store configs, upon which certain actions are taken, per source
source string required
Allowed values: bitcoinBuilder ftx ftx-retail ftx-bahamas ftx-bahamas-retail sofi bitcoinWell lucid
metadata object
The following fields: source, showBanner, readyForDistribution, showVideoIdBanner, ftxCreditorId were added for FTX insitutional distribution. Reference: https://bitgoinc.atlassian.net/browse/COPS-2695
videoIdRequired boolean
Check for video ID Users
contract object
Contract information
startDateOne of
endDateOne of
isExternal 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