---
title: "Search transfers with filters"
method: GET
path: "/entities/{entityDID}/tx/search"
tags: ["Transfers"]
---

# Search transfers with filters

`GET /entities/{entityDID}/tx/search`

## Path parameters

- `entityDID` string, did, required — Decentralized Identifier (DID)

## Query parameters

- `limit` integer
- `offset` integer
- `agent` DID[]
- `status` TransferStatus[]
- `asset` AssetIdentifier[]
- `party` string[]
- `refs` string[]
- `created_before` string, date-time
- `created_after` string, date-time
- `fields` string
- `direction` 'INCOMING' | 'OUTGOING' — The direction of a transfer relative to the entity
- `search_term` string
- `sort_by` string
- `sort_order` 'asc' | 'desc'
- `action_required` boolean
- `request_for_information` boolean
- `view` 'list'

## Response `200`

Search results retrieved successfully

- SearchTransferList
  - `data` SearchTransfer[], required
    - `id` string
    - `ref` string, nullable
    - `asset` string, nullable
    - `amount` string, nullable
    - `status` string, nullable
    - `entityDid` string, nullable
    - `direction` string, nullable
    - `initiator` string, nullable
    - `createdAt` union
      - string
      - string, date-time
    - `updatedAt` union
      - string
      - string, date-time
    - `expiresTime` union
      - string
      - string, date-time
    - `settledTime` union
      - string
      - string, date-time
    - `rejectedTime` union
      - string
      - string, date-time
    - `settlementId` string, nullable
    - `isTravelRule` boolean, nullable
    - `notabeneAsset` string, nullable
    - `authorizedTime` union
      - string
      - string, date-time
    - `settlementAddress` string, nullable
    - `presentationDefinitionUrl` string, nullable
    - `revertedTime` union
      - string
      - string, date-time
    - `settlementIdIndex` string, nullable
    - `originator` object, nullable
      - `@id` string, required
      - `originatorPerson` object[], nullable
    - `beneficiary` object, nullable
      - `@id` string, required
      - `beneficiaryPerson` object[], nullable
    - `agents` object[]
      - `@id` string, required
      - `@type` 'TransferAgent'
      - `id` string, nullable
      - `name` string, nullable
      - `agent` object, required
        - `@id` string, required
      - `logo` string, nullable
      - `jurisdiction` string, nullable
      - `did` string, nullable
      - `transferId` string, nullable
      - `role` 'VASP' | 'Custodian' | 'SettlementAddress' | 'SourceAddress' | 'Gateway' | 'Unknown', nullable
      - `for` string, nullable
      - `policies` object[], nullable
        - `@type` string, required
      - `memoTag` string, nullable
      - `status` 'PROCESSING' | 'AUTHORIZED' | 'REJECTED' | 'SETTLED' | 'FAILED' | 'REPLACED' | 'UNREACHABLE', nullable
      - `relationship` object, nullable
        - `@id` string, nullable
        - `from` string, nullable
        - `to` string, nullable
        - `status` string, nullable
        - `confirmedBy` string, nullable
      - `replacement` object, nullable
        - `@id` string, required
    - `matchedColumns` string[]
  - `pagination` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `400` — Bad Request - The server could not process the request due to a client error.
- `401` — Unauthorized - Authentication information is missing or invalid.
- `403` — Forbidden - The server understood the request but refuses to authorize it.
- `404` — Not Found - The requested resource could not be found.
- `409` — Conflict - The request could not be completed due to a conflict with the current state of the resource.
- `500` — Internal Server Error - An unexpected condition was encountered on the server.

---

[API](https://skmtc.net/notabene/apis/notabene-api.md) · [All operations](https://skmtc.net/notabene/apis/notabene-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notabene/notabene-api/versions/70056745a433/schema)