Ctrl+K

List pending approvals for a coin.

get/api/v2/{coin}/admin/pendingApprovals

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters

Query Parameters

  • limitstring<number>Default: 25
    Maximum number of results to return. If the result set is truncated, use the 'nextBatchPrevId' value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the 'nextBatchPrevId' value from the previous batch.
  • enterpriseIdstring
    Filter by enterprise.
  • walletIdstring
    Filter by wallet.
  • pendingApprovalIdstring
    Filter by pending approval id.
  • forCoinOnlyboolean
    If true, then filter for pending approvals matching the coin.
  • userIdstring
    Filter by user id.
  • statestring or string or string or string
    Filter by state.
  • daysToLookBackstring<number>
    Filter for pending approvals younger than "daysToLookBack" days.
    Minimum: >= 0
  • sortstring
    Sort pending approvals by field. For descending sort, prepend "-" to the field name.
    Enum: _id -_id

200 Response

One of
nextBatchPrevId string
When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the 'prevId' query parameter.
pendingApprovals array[object] required
actions array[object]
List of actions taken
addressLabels array[object]
Address labels of recipients in this Pending Approval
approvalsRequired number
Minimum: >= 1
Example: 1
approvedDate string <date-time>
The date when the approval was granted
approvers array[string]
List of approvers
associatedInquiries array[object]
Associated inquiries
bitgoOrg string
The BitGo organization
coin string
A cryptocurrency or token ticker symbol.
Example: btc
createDate string <date-time>required
The creation date of the pending approval
creator string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
freeze object
The freeze state
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
info object required
Information about the pending approval
keyCurve string
The key curve of the coin attached to this pending approval
Allowed values: secp256k1 ed25519 bls12_381
lastUpdated string <date-time>
The last date the approval was processing
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organizationName string
The organization name
policyEvaluationId string
ID for the policy evaluation
resolutionOrder array[object]
Order of resolution
resolvers array[object]
Resolvers for the pending approval
scope string required
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet organization global
singleRunResults array[object]
Results from single run checks
stateOne ofrequired
The state of the pending approval
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification pendingLivenessVerification pendingManualTrustReview pendingManualSupportReview pendingVideoApprovalFromSupport
txRequestId string <uuid>
Transaction request ID
Example: 123e4567-e89b-12d3-a456-426614174000
updatedAt string <date-time>
The date when the approval was last updated (any update, not just processing)
useLegacyPolicyEngine boolean
Flag to use legacy policy engine
userIds array[string]
All the Users who should see this Pending Approval
version number
Version of the pending approval
videoCallId string
ID for the video call
videoId object
ID for the video related to the approval
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletLabel string
Label for the wallet
wallets array[string]
The wallets of the pending approval
Example: 59cd72485007a239fb00282ed480da1f
walletType string

400 Response

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

404 Response

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