Sign in
Enterprise

Get enterprise

get/api/v2/enterprise/{enterpriseId}

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

excludeV1Walletsboolean

True, if excluding "wallets" field containing v1 wallet addresses from the enterprise

expandTotalWalletsCountboolean

True, if returning the total number of wallets for this enterprise

Response

OK

walletsstring[] required
stablecoinAgreementLatestVersionnumber
otcServicesAgreementLatestVersionnumber
hasScimClientboolean required

Whether the enterprise has a SCIM OAuth client configured

organizationIdstring
organizationstring
permissionsstring[]
isBeneficialOwnerboolean
acceptedInviteboolean
idstring required
namestring 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
typestring required
latestSAVersionSignednumber required
travelRuleboolean required
productLicensesstring[] required
canAccessBorrowingboolean required

whether the enterprise has the licence for BitGo Prime Borrowing

canAccessLendingboolean required

whether the enterprise has the licence for BitGo Prime Lending

canAccessSettlementboolean required

whether the enterprise has the licence to utilize settlement functionality

canAccessTradingboolean required

whether the enterprise has the licence to access BitGo Trading

canCreateColdWalletboolean required

whether the enterprise has the license to create cold wallets

canCreateHotWalletboolean required

whether the enterprise has the license to create hot wallets

canCreateCustodialWalletboolean required

whether the enterprise has the license to create custodial wallets

canCreateOffchainWalletboolean required

whether the enterprise has the license to create trading accounts

oneTimeFeesstring[] required
upfrontPaymentStatusstring required
ethAlwaysUseHopboolean required

Always use hop address for ETH transactions

usersViewAllWalletsboolean required

All users on the enterprise can view all enterprise wallets, even if they are not viewers on the wallet itself

videoIdWaivedboolean required

Whether the customer has waived the need for Video ID on low risk withdrawals.

createdAtstring

ISO 8601 creation timestamp derived from the MongoDB ObjectId

accountType'individual' | 'entity'
businessModel'bitgoAsAService' | 'cryptoAsAServiceParent' | 'cryptoAsAServiceChild'
complianceModel'EURegulated' | 'EUNonRegulated'
salesforceAccountIdstring

Opportunity ID from Salesforce

salesforceOpportunityIdstring
opportunityNamestring

Opportunity Name from Salesforce

salesEmailstring
cheetahAccountIdstring

CheetahAccountID is the unique ID for a BitGo Trust enterprise in Cheetah, which is the accounting system used by Trust.

primaryContactstring

The Id of the User who is the primary contact

emergencyPhonestring

Phone number for emergencies

pricingPlanstring

The pricing plan of the enterprise

approvalsRequirednumber

How many Enterprise Admins are required for action to fire

mutablePolicyWindownumber

Time in seconds after which policies on this Enterprise cannot be updated

bitgoEthKeystring

The public portion of the ethererum key generated for the enterprise fee address

ethFeeAddressstring

The eth fee address used to pay for network transaction fees of this enterprise

walletLimitobject
preferredUi'bg23' | '' | 'bg25-inst' | 'bg25-retail' | 'kintsugi'
custodialWalletLimitobject nullable
allowedCoinsstring[]
featureFlagsstring[]
labelsstring[]
publicLabelsstring[]
licensesstring[]
ellipticIdstring

Identifier for environment variables for a customer's Elliptic API credentials

ellipticHotWalletsboolean

Hot wallet transactions on this enterprise are monitored in Elliptic

restrictedDvpstring[]
vaspIdstring
bitgoVaspIdstring
coinSpecificobject
walletTypeCountsobject

Wallet type distribution (hot/cold/custodial/etc.)

source'bitcoinBuilder' | 'ftx' | 'ftx-retail' | 'ftx-bahamas' | 'ftx-bahamas-retail' | 'sofi' | 'sofiDocuSignPendingDeprecation' | 'bitcoinWell' | 'lucid' | 'wlf' | 'walrus' | 'mtgox' | 'landingPageReferral' | 'caas' | 'caas-testnet-prospect' | 'test'
totalWalletsCountnumber

The total number of wallets in the enterprise

migratedToNewPolicyServiceboolean

Whether the enterprise has been migrated to the new policy service

videoIdRequiredboolean

Check for video ID Users

referralCodestring

An Enterprise Referral Code

logoUrlstring

URL of the enterprise logo image

optOutOfPointsboolean

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'
requestedProductsstring[]
requestedBitgoProductsstring[]
isContractedClientboolean

True, if the enterprise has been onboarded by Salesforce

smartWorkQueuePriorityboolean

When true, Smart Work Queue treats this enterprise as priority for trust signing SLA tiers

Example response

{
  "organization": "59cd72485007a239fb00282ed480da1f",
  "id": "59cd72485007a239fb00282ed480da1f",
  "name": "Small Company",
  "usersViewAllWallets": true,
  "primaryContact": "59cd72485007a239fb00282ed480da1f",
  "emergencyPhone": "+11234567890",
  "approvalsRequired": 1,
  "mutablePolicyWindow": 172800,
  "totalWalletsCount": 1
}

Changes

Changed in 4 of the 33 revisions of this API.227

  • 4e2cf56dec091See the full diff
    • ●

      added the new Kyt enum value to the /// response property for the response status

      response-property-enum-value-added

  • 84c10109c46d1See the full diff
    • ○

      added the required property / to the response with the status

      response-required-property-added

  • 0136642b89d71See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • ee916dca3250215See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the // response's property type changed from string to no type for status

      response-property-type-changed

    • ●

      added the new Go Network - Off Exchange Settlement - OKX enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added to the // response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed the bitgoAsAService enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceChild enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceParent enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog