Ctrl+K

Get Travel Rule Transfers with PII

get/api/travel-rule/v1/admin/transfers

Get a list of travel rule transfers with personally identifiable information (PII).

Query Parameters

  • startDatestring<date-time>
    The start date for the transfer search in ISO 8601 format
  • endDatestring<date-time>
    The end date for the transfer search in ISO 8601 format
  • bitgoOrg
    The bitgoOrg for the transfer search
  • transferTypestring
    The transferType for the transfer search
    Enum: DEPOSIT WITHDRAWAL
  • minAmountstring
    The minAmount for the transfer search (in usd)
  • maxAmountstring
    The minAmount for the transfer search (in usd)
  • walletIdstring
    The walletId for the transfer search
  • sourceOfInformation
    The sourceOfInformation for the transfer search
  • enterpriseIdstring
    The enterpriseId for the transfer search
  • enterpriseNamestring
    The enterpriseName for the transfer search
  • txidstring
    The txid for the transfer search
  • transferIdstring
    The transferId for the transfer search
  • limitstring<number>
    The limit of transfers to return
  • nextCursorstring
    The id of transfer to return
  • directionstring<number>
    direction/sorting - 1 for ascending and -1 for descending

200 Response

transfers array[object] required
The list of transactions
id string
The ID of the transfer details
Min length: >= 1 characters
bitgoOrg string
The BitGo organization associated with the transfer.
Allowed values: 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
accountType string
The type of account (e.g., individual or entity).
Allowed values: individual entity
enterpriseName string
The name of the enterprise associated with the transfer.
enterpriseId string
The ID of the enterprise associated with the transfer.
walletName string
The name of the wallet involved in the transfer.
walletId string
The ID of the wallet involved in the transfer.
originatingAddress string
The address from which the transfer originated.
destinationAddress string
The address to which the transfer is sent.
txid string
The transfer ID.
transferId string
Transfer ID.
timestampOfTransfer string <date-time>
The timestamp of the transfer in ISO 8601 format.
transferType string
The type of transfer (e.g., deposit or withdrawal).
Allowed values: DEPOSIT WITHDRAWAL
usd number
The amount of the transfer in USD.
amount string
The amount of cryptocurrency involved in the transfer.
symbol string
The symbol of the cryptocurrency (e.g., BTC, ETH).
sourceOfInformation string
The source of information for the transfer.
Allowed values: TRUST SELF_DECLARATION SMALL_DEPOSIT_TEST MANUAL_ENTRY MISSING
pii object required
Personally identifiable information (PII) of the originator and beneficiary.
isSelfHostedWallet boolean
Indicates if the wallet is self-hosted.
vaspName string
The name of the Virtual Asset Service Provider (VASP).
isKnownVasp boolean
Indicates if the VASP is known.
jurisdiction string
The jurisdiction of the transfer.
comments array[string]
Additional comments or notes about the transfer.
hasMore boolean
Indicates if there are more transactions to fetch
nextCursor string
The nextId for pagination
prevCursor string
The prevId for pagination

400 Response

name string
context object required
error string required
requestId string required

401 Response

name string
context object required
error string required
requestId string required

404 Response

name string
context object required
error string required
requestId string required

500 Response

name string
context object required
error string required
requestId string required