--- title: "Get enterprise" method: GET path: "/api/v2/enterprise/{enterpriseId}" tags: ["Enterprise"] --- # Get enterprise `GET /api/v2/enterprise/{enterpriseId}` ## Path parameters - `enterpriseId` string, required ## Query parameters - `excludeV1Wallets` boolean - `expandTotalWalletsCount` boolean ## Response `200` OK - GetEnterpriseResponse - `wallets` string[], required - `tags` object[], required - `name` string, required - `id` string, required - `stablecoinAgreementLatestVersion` number - `otcServicesAgreementLatestVersion` number - `hasScimClient` boolean, required — Whether the enterprise has a SCIM OAuth client configured - `organizationId` string - `organization` string - `permissions` string[] - `isBeneficialOwner` boolean - `acceptedInvite` boolean - `id` string, required - `name` string, required - `bitgoOrg` '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', required - `kycState` 'unverified' | 'approved' | 'rejected' | 'pending' | 'qrscanned' | 'inreview' | 'flagged' | 'flagged_retry_allowed', required - `legalIdentifiers` LegalIdentifiers, required - `legalPersonNameIdentifierType` 'LEGL', required - `legalPersonName` string - `type` string, required - `latestSAVersionSigned` number, required - `travelRule` boolean, required - `productLicenses` 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` 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 - `videoIdWaived` boolean, required — Whether the customer has waived the need for Video ID on low risk withdrawals. - `createdAt` string — ISO 8601 creation timestamp derived from the MongoDB ObjectId - `additionalEnterpriseInfo` AdditionalEnterpriseInfo - `contact` GeographicAddress - `addressType` string - `name` string — Legal name of the enterprise, not necessarily the same as the display name - `street` string — Address line - `street2` string, nullable — Optional second address line - `suite` string, nullable — Optional suite number - `city` string — City name - `state` string — State or region - `postalCode` string — Postal code - `country` string — ISO 3166-1 Alpha-3 country code - `tradeOnboardingAgreement` OnboardingAgreement — 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` union, required - string - string, date-time - string, date - `ip` string - `stakingServicesAgreement` OnboardingAgreement — 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` union, required - string - string, date-time - string, date - `ip` string - `custodyServicesAgreement` CustodyServiceAgreement — 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. - `bitgoOrg` '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' - `user` string, required - `date` union, required - string - string, date-time - string, date - `ip` string - `distributedCustodyMicAgreement` OnboardingAgreement — 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` union, required - string - string, date-time - string, date - `ip` string - `stablecoinAgreement` object[] - `user` string, required — User who accepted the agreement - `date` union, required — Date when the agreement was accepted - string - string, date-time - string, date - `ip` string — IP address of the user - `version` number, required — Version number of the agreement - `otcServicesAgreement` object[] - `user` string, required — User who accepted the agreement - `date` union, required — Date when the agreement was accepted - string - string, date-time - string, date - `version` number, required — Version number of the agreement - `ip` string — IP address of the user - `bitgoOrg` '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' - `accountType` 'individual' | 'entity' - `businessModel` 'bitgoAsAService' | 'cryptoAsAServiceParent' | 'cryptoAsAServiceChild' - `complianceModel` 'EURegulated' | 'EUNonRegulated' - `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 - `emergencyPhone` string — Phone number for emergencies - `pricingPlan` string — The pricing plan of the enterprise - `approvalsRequired` number — How many Enterprise Admins are required for action to fire - `mutablePolicyWindow` number — Time in seconds after which policies on this Enterprise cannot be updated - `freeze` Freeze - `time` string, date-time — When the freeze started - `expires` string, date-time — 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` object - `preferredUi` 'bg23' | '' | 'bg25-inst' | 'bg25-retail' | 'kintsugi' - `custodialWalletLimit` object, nullable - `allowedCoins` string[] - `featureFlags` string[] - `labels` string[] - `publicLabels` string[] - `licenses` string[] - `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 - `restrictedDvp` string[] - `vaspId` string - `bitgoVaspId` string - `coinSpecific` object - `walletCounts` object — Number of wallets per coin - `enterpriseWallets` object, required - `walletTypeCounts` object — Wallet type distribution (hot/cold/custodial/etc.) - `activePricingType` FlattenedPricingType - `name` 'starter' | 'growth' | 'employee' | 'FTX Retail' | 'FTX Institutional', required - `startDate` union, required — 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. - string, date-time - string, date - `startReason` string, required — An optional note describing the reason the auditable item was added/created. - `id` string — Unique identifier for the date range. - `endDate` union — 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. - string, date-time - string, date - `endReason` string — An optional note describing the reason the auditable item was ended. - `source` 'bitcoinBuilder' | 'ftx' | 'ftx-retail' | 'ftx-bahamas' | 'ftx-bahamas-retail' | 'sofi' | 'sofiDocuSignPendingDeprecation' | 'bitcoinWell' | 'lucid' | 'wlf' | 'walrus' | 'mtgox' | 'landingPageReferral' | 'caas' | 'caas-testnet-prospect' | 'test' - `totalWalletsCount` number — The total number of wallets in the enterprise - `internal` EnterpriseInternal - `migratedToNewPolicyService` boolean, nullable, required — Whether the enterprise has been migrated to the new policy service - `policiesLocked` boolean, required - `umsMappingComplete` boolean, nullable, required - `distributedCustody` DistributedCustody - `signingBitgoOrg` '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' - `migratedToNewPolicyService` boolean — Whether the enterprise has been migrated to the new policy service - `videoIdUsers` object[] - `email` string, required — The email of the user - `userId` string, required — The user ID - `inviter` string, required — The inviter of the user - `state` 'awaitingApproval' | 'awaitingAcceptance' | 'pendingSchedule' | 'pendingInitialId' | 'underReview' | 'approved' | 'rejected' | 'archived', required - `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` object[] - `source` 'bitcoinBuilder' | 'ftx' | 'ftx-retail' | 'ftx-bahamas' | 'ftx-bahamas-retail' | 'sofi' | 'sofiDocuSignPendingDeprecation' | 'bitcoinWell' | 'lucid' | 'wlf' | 'walrus' | 'mtgox' | 'landingPageReferral' | 'caas' | 'caas-testnet-prospect' | 'test', required - `metadata` object — The following fields: source, showBanner, readyForDistribution, showVideoIdBanner, ftxCreditorId were added for FTX insitutional distribution. Reference: https://bitgoinc.atlassian.net/browse/COPS-2695 - `showBanner` boolean - `readyForDistribution` boolean - `showVideoIdBanner` boolean - `ftxCreditorId` string - `ftxHost` 'COM' | 'LIQUID' | 'US' - `creditorId` string - `videoIdRequired` boolean — Check for video ID Users - `contract` EnterpriseContract - `startDate` union - string, date - string, date-time - `endDate` union - string, date - string, date-time - `isExternal` boolean - `referralCode` string — An Enterprise Referral Code - `logoUrl` string — URL of the enterprise logo image - `oauthSetting` union - MicrosoftOAuthSetting - `oauthProvider` 'msEntra', required - `tenantId` string, required - `clientId` string, required - `clientSecret` string, required - OktaOAuthSetting - `oauthProvider` 'okta', required - `oktaDomain` string, required - `clientId` string, required - `clientSecret` string, required - `optOutOfPoints` boolean — Opt Out of Points System Flag - `requestedBitgoOrg` '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` string[] - `requestedBitgoProducts` string[] - `isContractedClient` boolean — True, if the enterprise has been onboarded by Salesforce - `smartWorkQueuePriority` boolean — When true, Smart Work Queue treats this enterprise as priority for trust signing SLA tiers - `documents` DocumentCollection - `required` string[] - `wForm` DocumentCollectionAgreement — 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` union, required - string - string, date-time - string, date - `ip` string ## Other responses - `400` — Bad Request - `404` — Not Found --- [API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)