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
walletsarray[string]required
tagsarray[object]required
namestringrequired
idstringrequired
idstringrequired
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
namestringrequired
Example: Small Company
additionalEnterpriseInfoobjectrequired
contactobject
bitgoOrgstringrequired
BitGo Organization related to this entity
Allowed values: BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1BitGo Inc
kycStatestringrequired
Allowed values: unverifiedapprovedrejectedpending
legalIdentifiersobjectrequired
legalPersonNameIdentifierTypestringrequired
Allowed value: LEGL
legalPersonNamestring
typestringrequired
latestSAVersionSignednumberrequired
Example: 0
travelRulebooleanrequired
productLicensesarray[string]required
canAccessBorrowingbooleanrequired
whether the enterprise has the licence for BitGo Prime Borrowing
canAccessLendingbooleanrequired
whether the enterprise has the licence for BitGo Prime Lending
canAccessSettlementbooleanrequired
whether the enterprise has the licence to utilize settlement functionality
canAccessTradingbooleanrequired
whether the enterprise has the licence to access BitGo Trading
canCreateColdWalletbooleanrequired
whether the enterprise has the license to create cold wallets
canCreateHotWalletbooleanrequired
whether the enterprise has the license to create hot wallets
canCreateCustodialWalletbooleanrequired
whether the enterprise has the license to create custodial wallets
canCreateOffchainWalletbooleanrequired
whether the enterprise has the license to create trading accounts
oneTimeFeesarray[string]required
upfrontPaymentStatusstringrequired
ethAlwaysUseHopbooleanrequired
Always use hop address for ETH transactions
usersViewAllWalletsbooleanrequired
All users on the enterprise can view all enterprise wallets, even if they are not viewers on the wallet itself
Example: true
videoIdWaivedbooleanrequired
Whether the customer has waived the need for Video ID on low risk withdrawals.
Example: false
tradeOnboardingAgreementobject
Who & when the MPA license was ack'd
userstringrequired
dateOne ofrequired
ipstring
stakingServicesAgreementobject
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.
userstringrequired
dateOne ofrequired
ipstring
custodyServicesAgreementobject
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.
userstringrequired
dateOne ofrequired
ipstring
accountTypestring
Indicates which type of KYC process the enterprise has to complete
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.
startReasonstringrequired
An optional note describing the reason the auditable item was added/created.
idstring
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.
endReasonstring
An optional note describing the reason the auditable item was ended.
The following fields: source, showBanner, readyForDistribution, showVideoIdBanner, ftxCreditorId were added for FTX insitutional distribution. Reference: https://bitgoinc.atlassian.net/browse/COPS-2695
videoIdRequiredboolean
Check for video ID Users
contractobject
Contract information
startDateOne of
endDateOne of
isExternalboolean
referralCodestring
Referral code
oauthSettingobject
oauth setting of the enterprise *
clientSecretstringrequired
clientIdstringrequired
tenantIdstringrequired
oauthProviderstringrequired
Allowed value: msEntra
optOutOfPointsboolean
Opt Out of Points System Flag
requestedBitgoOrgstring
Requested BitGo Org
Allowed values: BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo Sister Trust 1BitGo Inc