Update enterprise

Response Body

object

• accountType string enum
  Indicates which type of KYC process the enterprise has to complete
  individualentity
• additionalEnterpriseInfo object
  additionalEnterpriseInfo object

  • contact object
    contact object

    • name string
      Legal name of the enterprise, not neccessarily the enterprise name
    • street string
      Address line
    • street2 string nullable
      Optional 2nd address line
    • suite string
      Optional suite number
    • city string
      City name
    • state string
      State or region
    • postalCode string
      Postcal code
    • country string
      ISO 3166-1 Alpha-3 country code
• admin object
  admin object

  • policy object
    policy object

    • id string required

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

    • date string date-time
    • label string
    • latest boolean required
    • rules array of objects required
      rules object

      • id string required
      • lockDate string date-time required
        The time at which this rule becomes immutable
      • mutabilityConstraint string enum

        Specifies whether a BitGo admin can change lockDate

        • managed - Not locked, but requires approval from a BitGo admin to change
        • permanent - lockDate cannot be changed
        managedpermanent
      • coin string
        A cryptocurrency or token ticker symbol.
      • type string enum required
        What causes this rule to trigger
        advancedWhitelistallTxbitcoinAddressWhitelistcoinAddressWhitelistcoinAddressBlacklisttransactionLimitvelocityLimitwebhook
      • condition object
        Parameters for the type

        ONE OF

        Velocity limit USD velocity limit Whitelist Advanced whitelist Webhook

        • amountString string

          matches ^-?\d+$

        • timeWindow integer
          Time window in seconds for a velocity limit, between 1 and a month

          >= 0 · <= 2.6784e+06

      • action object required
        What happens when this rule is triggered
        action object

        • type string enum required
          denygetApprovalgetFinalApprovalgetCustodianApprovalgetIdVerification
        • userIds array of strings
          For a final approver action, who can approve
    • version integer required
• approvedVideoIdUsers array of strings
  IDs of users on the enterprise that are approved for custodial video ID
• approvalsRequired integer
  How many Enterprise Admins are required for action to fire
• bitgoEthKey string
  The public portion of the ethererum key generated for the enterprise fee address
• bitgoOrg string enum
  BitGo Organization related to this entity
  BitGo IncBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandFrankfurt DE TrustBitGo Sister Trust 1BitGo KoreaBitGo SingaporeBitGo Europe ApSBitGo Mena FzeBitGo Custody MENA FZEBitGo India
• canAccessBorrowing boolean
  whether the enterprise has the licence for BitGo Prime Borrowing
• canAccessLending boolean
  whether the enterprise has the licence for BitGo Prime Lending
• canAccessSettlement boolean
  whether the enterprise has the licence to utilize settlement functionality
• canAccessTrading boolean
  whether the enterprise has the licence to access BitGo Trading
• canCreateColdWallet boolean
  whether the enterprise has the license to create cold wallets
• canCreateCustodialWallets boolean
  whether the enterprise has the license to create custodial wallets
• canCreateHotWallet boolean
  whether the enterprise has the license to create hot wallets
• contract object
  contract object

  • startDate string
    The contract start date for an enterprise
  • endDate string
    The contract end date for an enterprise
• custodyServicesAgreement object
  Information about the signed custody services agreement
  custodyServicesAgreement object

  • user string required

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

  • date string date-time required
    The date when the agreement was signed
  • ip string
    The IP address from which the agreement was signed
  • bitgoOrg string enum
    BitGo Organization related to this entity
    BitGo IncBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandFrankfurt DE TrustBitGo Sister Trust 1BitGo KoreaBitGo SingaporeBitGo Europe ApSBitGo Mena FzeBitGo Custody MENA FZEBitGo India
• emergencyPhone string
  Phone number for emergencies
• ethFeeAddress string
  The eth fee address used to pay for network transaction fees of this enterprise
• freeze object
  freeze object

  • time string date-time
    When the freeze started
  • expires string date-time
    When the freeze will end
• id string required

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

• mutablePolicyWindow integer
  Time in seconds after which policies on this Enterprise cannot be updated
• name string
• pricingTypes array of objects
  pricingTypes object

  • name object
    name object

    • name string enum
      startergrowth
  • datesActive array of objects
    datesActive object

    • id string
      Unique identifier for the date range.
    • startDate string
      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
      An optional note describing the reason the auditable item was added/created.
    • endDate string
      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.
• activePricingType object
  activePricingType object

  • id string
    Unique identifier for the date range.
  • startDate string
    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
    An optional note describing the reason the auditable item was added/created.
  • endDate string
    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.
  • name string enum
    startergrowth
• kits array of objects
  kits object

  • name object
    name object

    • name string enum
      defaultwalletcustodyliquiditycryptoCompare
  • datesActive array of objects
    datesActive object

    • Same shape as AuditableItem.
• activeKits array of objects
  activeKits object

  • id string
    Unique identifier for the date range.
  • startDate string
    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
    An optional note describing the reason the auditable item was added/created.
  • endDate string
    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.
  • name string enum
    defaultwalletcustodyliquiditycryptoCompare
• primaryContact string
  The Id of the User who is the primary contact
• preferredUi string enum
  The UI that this enterprise prefers to use
  bg23bg25-instbg25-retailkintsugi
• totalWalletsCount integer
  The total number of wallets in the enterprise
• usersViewAllWallets boolean
  All users on the enterprise can view all enterprise wallets, even if they are not viewers on the wallet itself
• videoIdWaived boolean
  Whether the customer has waived the need for Video ID on low risk withdrawals.
• settings object
  Settings controlled by enterprise admins
  settings object

  • withdrawalAttestationRequired boolean
    Whether withdrawals must be confirmed with the initiator's passkey

Response Body

object

• id string

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

• enterprise string
  The Id of the associated enterprise
• walletId string
  The base address of the associated wallet
• creator string
  The Id of the User that created the Pending Approval
• createDate string date-time
• info object
  info object

  • type string enum
    bitcoinAddressWhitelistRequestuserChangeRequestpolicyRuleRequestdailyLimitPolicyRequesttransactionRequesttagUpdateRequestupdateEnterpriseRequestupdateApprovalsRequiredRequest
  • updateEnterpriseRequest object
    updateEnterpriseRequest object

    • action string enum
      addremove
    • permissions array of string enums
      admin
    • userId string
      The Id of the User to be added to or removed from the Enterprise
    • email string email
      E-Mail address of newly added users
  • updateApprovalsRequiredRequest object
    updateApprovalsRequiredRequest object

    • requestedApprovalsRequired number
      the number of approvalsRequired that should be changed to

      >= 1

• state string enum
  pendingapprovedrejected
• walletUserIds array of strings
  an array of all the Users on the Wallet who need to see this Pending Approval
• approvalsRequired number

  >= 1

• resolvers array of objects
  resolvers object

  • user string
  • date string
  • resolutionType string enum
    pendingapprovedrejected
  • signatures array of strings
  • videoApprover string
  • videoLink string
  • videoException string
• pendingApproval object
  Set when a settings change needs approval from other enterprise admins
  pendingApproval object

  • id string

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

  • coin string
    A cryptocurrency or token ticker symbol.
  • wallet string

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

  • enterprise string

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

  • organization string

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

  • creator string

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

  • createDate string date-time
  • info object

    ANY OF

    PendingApprovalTransactionRequest

    • transactionRequest object
      transactionRequest object

      • buildParams object
      • coinSpecific object
      • comment string
      • fee string or integer
      • isUnsigned boolean
      • recipients array of objects
        recipients object

        • address string

          up to 500 characters

        • amount string or integer
        • data string
      • requestedAmount object
        requestedAmount object

        • Same shape as PlatformIntegerOrIntegerString.
      • sourceWallet string

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

      • triggeredPolicy string

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

      • validTransaction string
      • validTransactionHash string
    • type string enum
      transactionRequest
  • state string

    ANY OF

    PlatformPendingApprovalStatePending PlatformPendingApprovalStateResolved

    string enum

  • scope string enum
    What kind of entity the Pending Approval is tied to
    enterprisewallet
  • userIds array of strings
    All the Users who should see this Pending Approval
  • approvalsRequired integer

    >= 1

  • walletLabel string
  • resolvers array of objects
    resolvers object

    • user string required
    • date string required
    • resolutionType string enum required
      approvedawaitingSignaturependingpendingBitGoAdminApprovalpendingCryptographicApprovalpendingCustodianApprovalpendingFinalApprovalpendingIdVerificationpendingVideoApprovalprocessingrejected
    • signatures array of strings required
    • videoApprover string
    • videoLink string
    • videoException string
  • addressLabels array of objects
    addressLabels object

    • address string required

      up to 500 characters

    • label string nullable required
      A human-readable label for the address.

      up to 250 characters

    • walletLabel string

Response Body

object

• error string required
  Human-readable error message
• requestId string required
  Client request id
• context object
  Properties that apply to a specific error name
• name string required
  Error code

Response Body

object

• error string required
  Human-readable error message
• requestId string required
  Client request id
• context object
  Properties that apply to a specific error name
• name string required
  Error code