Ctrl+K

List pending approvals

get/api/v2/pendingApprovals

Query Parameters

  • prevIdstring
    Return the next batch of results, based on the 'nextBatchPrevId' value from the previous batch.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • limitintegerDefault: 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
  • coinarray[string]
    Filter by coin
    Example: "btc"
  • enterpriseIdstring
    Filter by enterprise
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • organizationIdstring
    Filter by organization
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • statearray[string]
    Filter by state. The default behavior is to return objects where state is 'awaitingSignature', 'pending', or 'pendingFinalApproval'
    Enum: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification
  • walletIdstring
    Filter by wallet
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • expandWalletLabelsboolean
    True, if adding 'walletLabel' to each returned pending approval associated with a 'wallet'
  • expandAddressLabelsboolean
    If true, adds 'addressLabels' to each returned pending approval associated with recipient's addresses

200 Response

pendingApprovals array[object]
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
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]
addressLabels array[object]
Address labels of recipients in this Pending Approval