Ctrl+K

List pending approvals that require trust operator action

get/api/v2/admin/pendingApprovals/trustReport

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.
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • statearray[string]
    The state of the pending approvals to get. Defaults to ['pendingIdVerification', 'awaitingSignature', 'pendingCustodianApproval']
  • typearray[string]
    The type of pending approvals to get
  • enterpriseIdstring
  • bitgoOrgstring
    Filter by bitgoOrg
  • createDateFromstring
    Fetches pendingApprovals with a createDate greater than or equal the provided ISO datetime
  • createDateTostring
    Fetches pendingApprovals with a createDate lower than or equal the provided ISO datetime
  • approvedDateFromstring
  • approvedDateTostring
  • coinarray[string]
    Filter by coin
    Example: btc
  • coin.isFiatboolean
    Whether to filter by fiat/ non-fiat coins
  • subWalletTypestring
  • frozenboolean
  • 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

200 Response

pendingApprovals array[object] required
id string
Public ID of the pending approval
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
enterpriseName string
The name of the enterprise that is associated with the pending approval
isRetailEnterprise boolean
If the enterprise that is associated with the pending approval is a retail
enterpriseFeatureFlags array[string]
The feature flags of the enterprise
organization string
Public ID of the organization
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organizationName string
The name of the organization
creatorUserName string
The username of the creator
creatorPermissions array[string]
The permissions of the creator
walletLabel string
The label of the wallet
approvedVideoUsers array[object]
The approved video users
info object
recipientsInfo array[object]
Information about the recipients of the transaction
wallet string
Public ID of the wallet
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
txRequestId string <uuid>
The ID of the transaction request
Example: 123e4567-e89b-12d3-a456-426614174000
vaspId string
The ID of the VASP
transferId string
Public ID of the transfer
associatedInquiries array[object]
The associated inquiries
state string
State of the PA
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