Ctrl+K

List pending approvals that are awaiting signature

get/api/v2/pendingapprovals/awaitingSignature

Query Parameters

  • enterpriseIdstring
    Filter by enterprise
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • enterpriseBitGoOrgstring
    BitGo Organization related to this entity
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
  • reservationExpireTimestring
    When set, reserve all unspents used in transactions for this amount of time
  • idstring
    Only return PA with specified id if provided
  • coinsarray[string]
    Example: btc
  • limitstringDefault: 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.
  • skipBuildingTxsboolean
    Boolean describing whether or not we should skip building transactions as part of the endpoint. This parameter was added to support clients that may depend on having their transactions built as part of this API.
  • subWalletTypestring
  • excludeFiatboolean
    True if fiat currencies should be excluded
  • maxRequestedAmountstring<number>
    maximum amount of requestedAmount for the pending approvals should be included
  • minRequestedAmountstring<number>
    minimum amount of requestedAmount for the pending approvals should be included
  • walletTypesarray[string]
    filter by wallet types; no filtering is done if absent or empty
  • sortDirectionstring
    Sorts order by field in specified sort direction, default ascending.
    Enum: ASC DESC
  • keyCurvestring
    Filters by key curve
    Enum: secp256k1 ed25519 bls12_381

200 Response

transactions array[object] required
The list of transactions awaiting signature
consolidateId string
The ID of the consolidation
ofcCreatorUserName string
Username of the ofc transfer creator (Only returned for Backing wallet transactions)
ofcCreator string
Public ID of the ofc transfer creator (Only returned for Backing wallet transactions)
ofcEnterprise string
Public ID of the enterprise associated with the ofc transfer (Only returned for Backing wallet transactions)
ofcEnterpriseName string
Name of the enterprise associated with the ofc transfer (Only returned for Backing wallet transactions)
ofcWallet string
Public ID of the wallet associated with the ofc transfer (Only returned for Backing wallet transactions)
ofcTransferState string
The state of the OFC transfer
ofcTransferComment string
The comment of the OFC transfer
reservation object
coin string
A cryptocurrency symbol or token ticker symbol
Example: btc
token string
The token type
keyDerivationPath string
The key derivation path
freeze object
The pending approval freeze state
transferId string
Public ID of the transfer
errors array[object]
The list of errors
enterpriseId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterpriseName string
coin string
A cryptocurrency symbol or token ticker symbol
Example: btc
buildResult object
The result of the build
nextBatchPrevId string <uuid>
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

error string required