API Reference
GuidesReleasesPostmanRecipesAPI Reference

Remove an agent from a transfer

post
https://api.eu1.notabene.id/entities//tx//agents/remove

Removes an existing agent from a transfer. The agent is soft-deleted (marked with removed_at timestamp). The caller must be the transfer initiator, a gateway, or have a relationship with the agent being removed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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

uuid
required

The transfer ID

Body Params
string
required
length between 1 and 255

DID of the agent to be removed

string
length ≤ 500

Reason for removing the agent

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?