Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Enterprise

Update enterprise

put/api/v2/enterprise/{enterpriseId}

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

The enterprise ID

Request body

approvalsRequiredinteger

How many Enterprise Admins are required for action to fire

usersViewAllWalletsboolean

Allow users to view all wallets

preferredUi'bg23' | 'bg25-inst' | 'bg25-retail' | 'kintsugi'

Example request

{
  "legalIdentifiers": {
    "legalPersonName": "Pineapple Capital Inc"
  }
}

Response

OK

accountType'individual' | 'entity'

Indicates which type of KYC process the enterprise has to complete

approvedVideoIdUsersId[]

IDs of users on the enterprise that are approved for custodial video ID

approvalsRequiredinteger

How many Enterprise Admins are required for action to fire

bitgoEthKeystring

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

bitgoOrg'BitGo Inc' | 'BitGo Trust' | 'BitGo New York' | 'BitGo Germany' | 'BitGo Switzerland' | 'Frankfurt DE Trust' | 'BitGo Sister Trust 1' | 'BitGo Korea' | 'BitGo Singapore' | 'BitGo Europe ApS' | 'BitGo Mena Fze' | 'BitGo Custody MENA FZE' | 'BitGo India'

BitGo Organization related to this entity

canAccessBorrowingboolean

whether the enterprise has the licence for BitGo Prime Borrowing

canAccessLendingboolean

whether the enterprise has the licence for BitGo Prime Lending

canAccessSettlementboolean

whether the enterprise has the licence to utilize settlement functionality

canAccessTradingboolean

whether the enterprise has the licence to access BitGo Trading

canCreateColdWalletboolean

whether the enterprise has the license to create cold wallets

canCreateCustodialWalletsboolean

whether the enterprise has the license to create custodial wallets

canCreateHotWalletboolean

whether the enterprise has the license to create hot wallets

emergencyPhonestring

Phone number for emergencies

ethFeeAddressstring

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

idstring required
mutablePolicyWindowinteger

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

namestring
primaryContactstring
preferredUi'bg23' | 'bg25-inst' | 'bg25-retail' | 'kintsugi'
totalWalletsCountinteger

The total number of wallets in the enterprise

usersViewAllWalletsboolean

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

videoIdWaivedboolean

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

Example response

{
  "additionalEnterpriseInfo": {
    "contact": {
      "name": "Jane Doe",
      "street": "1",
      "street2": "Wall Street",
      "suite": "3",
      "city": "New York",
      "state": "NY",
      "postalCode": "10005",
      "country": "USA"
    }
  },
  "admin": {
    "policy": {
      "id": "59cd72485007a239fb00282ed480da1f",
      "rules": [
        {
          "coin": "btc",
          "condition": {
            "amountString": "2000000"
          },
          "action": {
            "userIds": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          }
        }
      ]
    }
  },
  "approvedVideoIdUsers": [
    "59cd72485007a239fb00282ed480da1f"
  ],
  "approvalsRequired": 1,
  "custodyServicesAgreement": {
    "user": "59cd72485007a239fb00282ed480da1f"
  },
  "emergencyPhone": "+11234567890",
  "id": "59cd72485007a239fb00282ed480da1f",
  "mutablePolicyWindow": 172800,
  "name": "Small Company",
  "primaryContact": "59cd72485007a239fb00282ed480da1f",
  "totalWalletsCount": 1,
  "usersViewAllWallets": true,
  "videoIdWaived": true
}