REST API›Organization›Organization Management

GET

Get child enterprise

Get a child enterprise by its ID for a child enterprise within an organization.

Path Params

  • enterpriseId string required
    The ID of the child enterprise within the organization

Query Params

  • organizationId string required
    The ID of the organization that owns the enterprise

Responses

200

Response Body

object

  • organizationEnterprise object required
    organizationEnterprise object
    • enterprise object required
      enterprise object
      • id string required
      • name string required
      • bitgoOrg string enum required
        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
      • canAccessLending boolean required
      • canAccessSettlement boolean required
      • canAccessTrading boolean required
      • canCreateColdWallet boolean required
      • canCreateHotWallet boolean required
      • canCreateCustodialWallet boolean required
      • canCreateOffchainWallet boolean required
      • oneTimeFees array of strings required
      • upfrontPaymentStatus string required
      • ethAlwaysUseHop boolean required
      • usersViewAllWallets boolean required
      • videoIdWaived boolean required
      • createdAt string
      • additionalEnterpriseInfo object
        additionalEnterpriseInfo object
        • contact object
          contact object
          • addressType string
          • name string
          • street string
          • street2 string or object
          • suite string or object
          • city string
          • state string
          • postalCode string
          • country string
      • tradeOnboardingAgreement object
        tradeOnboardingAgreement object
        • user string required
        • date string required
        • ip string required
      • stakingServicesAgreement object
        stakingServicesAgreement object
        • user string required
        • date string required
        • ip string required
      • custodyServicesAgreement object
        custodyServicesAgreement object
        • user string required
        • date string required
        • ip string required
        • bitgoOrg string enum
          BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
      • distributedCustodyMicAgreement object
        distributedCustodyMicAgreement object
        • user string required
        • date string required
        • ip string required
      • stablecoinAgreement array of objects
        stablecoinAgreement object
        • user string required
        • date string required
        • ip string required
        • version number required
      • accountType string enum
        individualentity
      • businessModel string or object

        ANY OF

        string enum

      • complianceModel string enum
        EURegulatedEUNonRegulated
      • salesforceAccountId string
      • salesforceOpportunityId string
      • opportunityName string
      • salesEmail string
      • cheetahAccountId string
      • primaryContact string
      • emergencyPhone string
      • pricingPlan string
      • approvalsRequired number
      • mutablePolicyWindow number
      • freeze object
        freeze object
        • time string
        • expires string
        • reason string
        • frozenBy string
        • unFrozenBy string
      • bitgoEthKey string
      • ethFeeAddress string
      • walletLimit map of numbers
        walletLimit object
        • <key> number
      • preferredUi string enum
        bg23bg25-instbg25-retailkintsugi
      • custodialWalletLimit object

        ANY OF

        • <key> number
      • allowedCoins array of strings
      • featureFlags array of strings
      • labels array of strings
      • publicLabels array of strings
      • licenses array of strings
      • ellipticId string
      • ellipticHotWallets boolean
      • restrictedDvp array of strings
      • vaspId string
      • bitgoVaspId string
      • coinSpecific map of objects
        coinSpecific object
        • <key> object nullable
      • walletCounts object
        walletCounts object
        • enterpriseWallets map of numbers required
          enterpriseWallets object
          • <key> number
      • walletTypeCounts map of numbers
        walletTypeCounts object
        • <key> number
      • activePricingType object

        ANY OF

        • name string enum required
          startergrowthemployeeFTX RetailFTX Institutional
        • startDate string required
        • startReason string required
        • id string
        • endDate string or object
        • endReason string
      • source string enum
        bitcoinBuilderftxftx-retailftx-bahamasftx-bahamas-retailsofisofiDocuSignPendingDeprecationbitcoinWelllucidwlfwalrusmtgoxlandingPageReferralcaascaas-testnet-prospecttest
      • totalWalletsCount number
      • internal object
        internal object
        • migratedToNewPolicyService boolean or object required
        • policiesLocked boolean required
        • umsMappingComplete boolean or object 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
      • videoIdUsers array of objects
        videoIdUsers object
        • email string required

          at least 1 characters

        • userId string required

          at least 1 characters

        • inviter string required

          at least 1 characters

        • state string enum required
          awaitingApprovalawaitingAcceptancependingSchedulependingInitialIdunderReviewapprovedrejectedarchived
        • videoCallId string
        • approvalDate string
        • archivedDate string
        • pendingApprovalId string
        • videoLink string
        • enterpriseId string
        • enterpriseName string
      • sourceConfig array of objects
        sourceConfig object
        • source string enum required
          bitcoinBuilderftxftx-retailftx-bahamasftx-bahamas-retailsofisofiDocuSignPendingDeprecationbitcoinWelllucidwlfwalrusmtgoxlandingPageReferralcaascaas-testnet-prospecttest
        • metadata object
          metadata object
          • showBanner boolean
          • readyForDistribution boolean
          • showVideoIdBanner boolean
          • ftxCreditorId string
          • ftxHost string enum
            COMLIQUIDUS
          • creditorId string
      • videoIdRequired boolean
      • contract object
        contract object
        • startDate string
        • endDate string or object
        • isExternal boolean
      • referralCode string
      • logoUrl string
      • oauthSetting object

        ANY OF

        • clientId string required
        • clientSecret string required
        • oauthProvider string enum required
          msEntra
        • tenantId string required
      • optOutOfPoints boolean
      • requestedBitgoOrg string enum
        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 NetworkGo Network - Off Exchange Settlement - OKXStakingTradeHot Self-CustodyEscrowEscrow - TripartyDistributed CustodyAdvanced WalletsStablecoinsLoans against Go AccountAuto LiquidationACH DebitsGo LightningTrade FIX APIGo StakingLink
      • isContractedClient boolean
      • smartWorkQueuePriority boolean
      • documents object
        documents object
        • required array of string enums
          wForm
        • wForm object
          wForm object
          • user string required
          • date string required
          • ip string required
      • organization string
      • permissions array of string enums
        adminauditorwallet.create
      • isBeneficialOwner boolean
      • acceptedInvite boolean
    • account string required