Ctrl+K

List pending approvals (coin-agnostic) with filtering by state and resourceType.

get/api/v2/admin/pendingapprovals

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.
  • statestring or string or string or string
    Filter by pending approval state.
  • resourceTypestring
    Filter by resource type (e.g., userEmail). This filter applies to genericRequest type pending approvals.
  • userIdstring
    Filter by user ID (public id string). This filter applies to genericRequest type pending approvals and matches against info.genericRequest.metadata.userId.

200 Response

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

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