Ctrl+K

Get enterprise

get/api/v2/enterprise/{enterpriseId}

Path Parameters

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

200 Response

accountType string
Indicates which type of KYC process the enterprise has to complete
Allowed values: individual entity
additionalEnterpriseInfo object
contact object required
Example: {"name":"Jane Doe","street":"1","street2":"Wall Street","suite":"3","city":"New York","state":"NY","postalCode":"10005","country":"USA"}
admin object
policy object
approvedVideoIdUsers array
IDs of users on the enterprise that are approved for custodial video ID
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
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
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
time string <date-time>
When the freeze started
expires string <date-time>
When the freeze will end
mutablePolicyWindow integer
Time in seconds after which policies on this Enterprise cannot be updated
Example: 172800
name string
Example: Small Company
pricingTypes array[object]
name object
datesActive array[object]
activePricingType
kits array[object]
name object
datesActive array
activeKits array
primaryContact string
The Id of the User who is the primary contact
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
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[object]
name string
wallets array[string]

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