Get a specific transfer

get

https://api.eu1.notabene.id/entities/{entityDID}/tx/{transferId}

Retrieves detailed information about a specific transfer including status, agents, and policy evaluations. Supports optional PII decryption, timeline, and integration results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityDID

string

required

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

transferId

uuid

required

The transfer ID

Query Params

decrypt

string

enum

Defaults to false

Whether to decrypt PII data in the response

Allowed:

sanitize

string

enum

Defaults to true

Whether to sanitize sensitive data in the response

Allowed:

include_timeline

string

enum

Defaults to false

Whether to include the timeline of events for the transfer

Allowed:

include_integration_results

string

enum

Defaults to false

Whether to include integration results in the response

Allowed:

include_replaced

string

^(true|false)$

Whether to include replaced agents in the response

include_removed

string

^(true|false)$

include_comments

string

^(true|false)$

Responses

200Transfer details retrieved successfully

400Bad Request - The server could not process the request due to a client error.

401Unauthorized - Authentication information is missing or invalid.

403Forbidden - The server understood the request but refuses to authorize it.

404Not Found - The requested resource could not be found.

409Conflict - The request could not be completed due to a conflict with the current state of the resource.

500Internal Server Error - An unexpected condition was encountered on the server.