/api/v2/{coin}/wallet/{walletId}/policy/rule
Adds a rule to a wallet’s policy. A wallet policy’s rules control the conditions under which BitGo will use its single key to sign a transaction. An email notification will be sent to all wallet users when a policy is updated. This email is NOT sent for the first time policy is added.
coin
stringRequiredbtc
walletId
stringRequired59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
coin
string zrx
id
string required type
string required advancedWhitelist
allTx
allTxNoFiat
coinAddressWhitelist
coinAddressBlacklist
velocityLimit
webhook
condition
Any ofadd
object required action
object required type
string required deny
getApproval
getGroupApproval
getFinalApproval
getCustodianApproval
getIdVerification
noop
approvalsRequired
integer >= 1
1
userIds
array[string] 59cd72485007a239fb00282ed480da1f
admin
object policy
object allowBackupKeySigning
boolean approvalsRequired
integer required >= 1
1
balanceString
string 2000000
^-?\d+$
buildDefaults
object minFeeRate
integer >= 1000
12000
changeAddressType
string p2sh
p2shP2wsh
p2wsh
p2tr
p2trMusig2
default
p2wsh
txFormat
string legacy
psbt
psbt
coin
string required btc
coinSpecific
One ofcreationFailure
array[string] b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
pendingChainInitialization
boolean custodialWallet
object custodialWalletId
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
deleted
boolean required disableTransactionNotifications
boolean required enterprise
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
freeze
object time
string <dateTime>
expires
string <dateTime>
id
string required 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
isCold
boolean keys
array[string] 59cd72485007a239fb00282ed480da1f
label
string required My Wallet
m
integer 2
n
integer 3
nodeId
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
receiveAddress
object id
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
address
string <= 250 characters
2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
chain
integer 0
1
10
11
20
21
30
31
40
41
1
index
integer coin
string lastNonce
integer -1
wallet
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
coinSpecific
object balance
object label
<= 250 characters
Bob's Hot Wallet Address
addressType
string p2sh
p2shP2wsh
p2wsh
p2tr
p2trMusig2
p2sh
recoverable
boolean tags
array[string] 59cd72485007a239fb00282ed480da1f
spendableBalanceString
string 2000000
^-?\d+$
unspentCount
number 100
startDate
string <date-time>
2018-05-05T19:46:22.019Z
type
string cold
custodial
custodialPaired
hot
trading
distributedCustody
users
array[object] {"user":"55e8a1a5df8380e0e30e20c6","permissions":["admin","view","spend"]}
user
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
permissions
array[string] admin
view
spend
customChangeKeySignatures
object user
string backup
string bitgo
string multisigType
string onchain
tss
blsdkg
multisigTypeVersion
string MPCv2
id
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
coin
string btc
wallet
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
enterprise
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
organization
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
creator
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
createDate
string <date-time>
info
Any oftransactionRequest
object type
string transactionRequest
state
Any ofpending
awaitingSignature
pendingFinalApproval
pendingCustodianApproval
pendingVideoApproval
pendingIdVerification
scope
string enterprise
wallet
userIds
array[string] 59cd72485007a239fb00282ed480da1f
approvalsRequired
integer >= 1
1
walletLabel
string resolvers
array[object] user
string required date
string required resolutionType
string required approved
awaitingSignature
pending
pendingBitGoAdminApproval
pendingCryptographicApproval
pendingCustodianApproval
pendingFinalApproval
pendingIdVerification
pendingVideoApproval
processing
rejected
signatures
array[string] required videoApprover
string videoLink
string videoException
string addressLabels
array[object] address
string required <= 250 characters
2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label
<= 250 characters
Bob's Hot Wallet Address
walletLabel
string My Wallet
error
string required requestId
string required context
object name
string required