Ctrl+K

Get transaction requests ready for trust signature

get/api/v2/admin/txRequests/awaitingSignature

Get a list of annotated transaction requests.

Query Parameters

  • limitstring or stringDefault: 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
  • txRequestIdsarray[string]
    If provided, only the specified transaction requests will be returned.
  • signingStagestring
    If provided, only transaction requests in a particular signing stage will be returned.
    Enum: 1-eddsa 2-eddsa 3-eddsa 4-eddsa 1-ecdsa 2-ecdsa 3-ecdsa 1-ecdsa-mpcv2 2-ecdsa-mpcv2 3-ecdsa-mpcv2 4-ecdsa-mpcv2
  • bitgoOrgstring
    Filter by bitgoOrg
    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
  • enterpriseIdstring
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Min length: >= 1 characters
  • sortBystring
    Sorts by specified field, default sorting by id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Enum: id createdDate
  • sortDirectionstring
    Sorts order by field in specified sort direction, default ascending.
    Enum: ASC DESC
  • walletTypesarray[string]
    If provided, only transaction requests in a particular wallet type will be returned. By default, all wallet types will be returned.
    Enum: backing cold custodial custodialPaired hot advanced trading
  • walletSubTypesarray[undefined]Required
    If provided, only transaction requests in a particular wallet subType will be returned. If `none` is provided, transaction requests with wallets with no subType will be returned. The default value is `none` and `custodialCold`.
  • frozenboolean
    True if frozen transaction requests should be included
  • coinsarray[string]
    If provided, only transaction requests pertaining to specific coins will be returned
  • enterpriseSourcestring
    Enum: ftx nonFtx
  • requestTypestring
    Enum: tx message

200 Response

txRequests array[object] required
walletLabel string
walletCoin string
enterpriseName string
recipientsInfo array[object]
ofcEnterpriseName string
ofcEnterpriseId string
ofcWalletId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
ofcTransferComment string
freeze object
isTestTransaction boolean
transactions array[object]
The transactions associated with the transaction request
messages array[object]
The messages associated with the transaction request
apiVersion string
The API version of the transaction request
Allowed values: lite full
txRequestId string <uuid>required
A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
Example: 123e4567-e89b-12d3-a456-426614174000
idempotencyKey string
The idempotency key of the transaction request
walletId string required
The id of the Wallet the TxRequest is for.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletType string
The type describes who owns the keys to the wallet associated to the TxRequest.
Allowed values: backing cold custodial custodialPaired hot advanced trading
version number required
The version of the transaction request
enterpriseId string
If the wallet that owns the TxRequest is owned by an enterprise then this is the Id of said enterprise.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
state string required
Allowed values: pendingApproval canceled rejected initialized pendingDelivery delivered pendingUserSignature pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend signed failed
date string <date-time>required
The date and time this version of the TxRequest document was created.
Example: 2021-01-01T00:00:00.000Z
createdDate string <date-time>required
The date and time the version 1 TxRequest document was created.
Example: 2021-01-01T00:00:00.000Z
userId string required
The Id of the User that produced this version of the TxRequest document. Could have created a new document or updated an existing document.
initiatedBy string required
The Id of the User that originally created the TxRequest document (initiated the TxRequest).
updatedBy string required
The Id of the User that last updated the TxRequest document. This is an alias for the userId field.
intent
The intent of the transaction request
intents array required
pendingApprovalId string
The id of the Pending Approval that was created for the TxRequest if one was required.
policiesChecked boolean
latest boolean required
Indicates if this is the latest transaction request
isCanceled boolean
True, if the transaction request is canceled.
bitgoRangeProofChallenge object
ntildeProof object required
The ntildeProof value is only required when creating the initial config.
ntilde string required
Range proof challenge value
h1 string required
Range proof challenge value
h2 string required
Range proof challenge value
errors array[object] required
enterpriseId string
enterpriseName string
walletId string
walletLabel string
coin string
pendingApprovalId string
unsignedTx object
transactions array[object]
message string required
stack string required
totalCount number
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

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

401 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

403 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