REST API›Enterprise

GET

List enterprises

Query Params

  • expandTotalWalletCounts boolean
    True, if returning the total number of wallets for each enterprise.
  • excludeWalletMemberships boolean
    True, if excluding enterprises that the user joined only through wallet memberships.

Responses

200
OK

Response Body

object

  • enterprises array of objects required

    ONE OF

    • organization string
      Organization ID reference
    • permissions array of string enums
      adminauditorwallet.create
    • isBeneficialOwner boolean
    • acceptedInvite boolean
    • id string required

      matches ^[0-9a-f]{32}$

    • name string required
    • bitgoOrg string enum required
      BitGo Organization related to this entity
      BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
    • kycState string enum required
      unverifiedapprovedrejectedpendingqrscannedinreviewflaggedflagged_retry_allowed
    • legalIdentifiers object required
      legalIdentifiers object
      • legalPersonNameIdentifierType string enum required
        LEGL
      • legalPersonName string
    • type string required
    • latestSAVersionSigned number required
    • travelRule boolean required
    • productLicenses array of strings 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 of strings 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 object
      additionalEnterpriseInfo object
      • contact object
        contact object
        • 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 object
      Who & when the MPA license was ack'd
      tradeOnboardingAgreement object
      • user string required
      • date string 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.
      stakingServicesAgreement object
      • user string required
      • date string 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.
      custodyServicesAgreement object
      • bitgoOrg string enum
        BitGo Organization related to this custody service agreement
        BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
      • user string required
      • date string required
      • ip string
    • distributedCustodyMicAgreement 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.
      distributedCustodyMicAgreement object
      • Same shape as OnboardingAgreement.
    • stablecoinAgreement array of objects
      stablecoinAgreement object
      • user string required
        User who accepted the agreement
      • date string required
        Date when the agreement was accepted
      • ip string
        IP address of the user
      • version number required
        Version number of the agreement
    • accountType string enum
      Indicates which type of KYC process the enterprise has to complete
      individualentity
    • businessModel string enum
      bitgoAsAServicecryptoAsAServiceParentcryptoAsAServiceChild
    • complianceModel string enum
      Regulatory compliance model for EU CaaS clients
      EURegulatedEUNonRegulated
    • 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

      matches ^[0-9a-f]{32}$

    • 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 object
      freeze object
      • 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 map of numbers
      walletLimit object
      • <key> number
    • preferredUi string enum
      The UI that this enterprise prefers to use
      bg23bg25-instbg25-retailkintsugi
    • custodialWalletLimit map of numbers nullable
      custodialWalletLimit object
      • <key> number
    • allowedCoins array of strings
    • featureFlags array of strings
    • labels array of strings
    • publicLabels array of strings
    • licenses array of strings
    • 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 array of strings
    • vaspId string
    • bitgoVaspId string
    • coinSpecific map of objects
      coinSpecific object
      • <key> object
    • walletCounts object
      Number of wallets per coin
      walletCounts object
      • enterpriseWallets map of numbers required
        enterpriseWallets object
        • <key> number
    • walletTypeCounts map of numbers
      Wallet type distribution (hot/cold/custodial/etc.)
      walletTypeCounts object
      • <key> number
    • activePricingType object nullable
      activePricingType object
      • name string enum required
        startergrowthemployeeFTX RetailFTX Institutional
      • startDate string 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.
      • startReason string required
        An optional note describing the reason the auditable item was added/created.
      • id string
        Unique identifier for the date range.
      • endDate string nullable
        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 enum
      bitcoinBuilderftxftx-retailftx-bahamasftx-bahamas-retailsofisofiDocuSignPendingDeprecationbitcoinWelllucidwlfwalrusmtgoxlandingPageReferralcaascaas-testnet-prospecttest
    • totalWalletsCount number
      The total number of wallets in the enterprise
    • internal object
      internal object
      • migratedToNewPolicyService boolean nullable required
        Whether the enterprise has been migrated to the new policy service
      • policiesLocked boolean required
      • umsMappingComplete boolean nullable required
    • distributedCustody object
      distributedCustody object
      • signingBitgoOrg string enum
        BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
    • migratedToNewPolicyService boolean
      Whether the enterprise has been migrated to the new policy service
    • videoIdUsers array of objects
      videoIdUsers object
      • email string required
        The email of the user

        at least 1 characters

      • userId string required
        The user ID

        at least 1 characters

      • inviter string required
        The inviter of the user

        at least 1 characters

      • state string enum required
        The state of the user
        awaitingApprovalawaitingAcceptancependingSchedulependingInitialIdunderReviewapprovedrejectedarchived
      • 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 of objects
      sourceConfig object
      • source string enum required
        bitcoinBuilderftxftx-retailftx-bahamasftx-bahamas-retailsofisofiDocuSignPendingDeprecationbitcoinWelllucidwlfwalrusmtgoxlandingPageReferralcaascaas-testnet-prospecttest
      • metadata object
        The following fields: source, showBanner, readyForDistribution, showVideoIdBanner, ftxCreditorId were added for FTX insitutional distribution. Reference: https://bitgoinc.atlassian.net/browse/COPS-2695
        metadata object
        • showBanner boolean
        • readyForDistribution boolean
        • showVideoIdBanner boolean
        • ftxCreditorId string
        • ftxHost string enum
          COMLIQUIDUS
        • creditorId string
    • videoIdRequired boolean
      Check for video ID Users
    • contract object
      Contract information
      contract object
      • startDate string
      • endDate string nullable
      • isExternal boolean
    • referralCode string
      Referral code
    • logoUrl string
      URL of the enterprise logo image
    • oauthSetting object
      oauth setting of the enterprise *

      ONE OF

      • oauthProvider string enum required
        msEntra
      • tenantId string required
      • clientId string required
      • clientSecret string required
    • optOutOfPoints boolean
      Opt Out of Points System Flag
    • requestedBitgoOrg string enum
      Requested BitGo Org
      BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
    • requestedProducts array of string enums
      ACH DebitsBitGo MMIBitGo Qualified CustodyBitGo Qualified Custody & Hot WalletBorrowingBorrowing / LendingLendingNFTsSelf CustodyGo Network: Off Exchange SettlementStakingTradeTransactional / Hot WalletWrapped Asset ServicesEscrowEscrow - TripartyDistributed Custody WalletToken Management (HZ)Platform Integration (B2B2C)BitGo Wealth Management (HZ)BitGo ConciergeCoincover ReferralGo Network: Fiat currency SettlementFiat Currency CustodyExcess InsuranceSetupLightningLiquidity ProviderAlliance AgreementBitGo CustodyBitGo MMI (Inc)Coincover Referral (Inc)Custom ProjectNFTs (Inc)Other (Inc)Partial SignaturePortfolio & TaxProfessional ServicesSetup (Inc)Staking (Inc)Platform Integration (B2B2C) (Inc)OTC Trading
    • requestedBitgoProducts array of string enums
      Instant Fee WalletsGo AccountSettlementTaxTrade APIMargin TradingEllipticCryptoCompareMetaMaskCustodyBorrowingLendingDeFiCold Self-CustodyGo NetworkStakingTradeHot Self-CustodyEscrowEscrow - TripartyDistributed CustodyAdvanced WalletsStablecoinsLoans against Go AccountAuto LiquidationACH DebitsGo LightningTrade FIX APIGo StakingLink
    • 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 object
      Documents that need to be collected from this enterprise
      documents object
      • required array of string enums
        wForm
      • wForm 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.
        wForm object
        • user string required
        • date string required
        • ip string
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id