Ctrl+K

Whitelist a trading partner

put/api/v2/internal/wallet/{walletId}/policy/tradingpartner

Adds a trading partner to the whitelist, or creates a pending approval if there are multiple admins on the wallet.

Path Parameters

  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

partnerAccountId string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
requestingUser string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
date string <date-time>
label string
latest boolean required
rules array[object] required
id string required
lockDate string <date-time>required
The time at which this rule becomes immutable
mutabilityConstraint string
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
Allowed values: managed permanent
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string required
What causes this rule to trigger
Allowed values: advancedWhitelist allTx bitcoinAddressWhitelist coinAddressWhitelist coinAddressBlacklist transactionLimit velocityLimit webhook
conditionOne of
Parameters for the type
action object required
What happens when this rule is triggered
version integer required

202 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
A cryptocurrency or token ticker symbol.
Example: btc
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
creator string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>
infoAny of
transactionRequest object
type string
Allowed value: transactionRequest
stateAny of
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification
scope string
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet
userIds array[string]
All the Users who should see this Pending Approval
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired integer
Minimum: >= 1
Example: 1
walletLabel string
resolvers array[object]
user string required
date string required
resolutionType string required
Allowed values: 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 labels of recipients in this Pending Approval
address string required
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label
string or null
required
A human-readable label for the address.
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
walletLabel string
Example: My Wallet

400 Response

One of
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