v1
latestOpenAPI 3.1.02026-07-2685154311.7 KBTransfers
Remove an agent from a transfer
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.
post/entities/{entityDID}/tx/{transferId}/agents/remove
Path parameters
entityDIDstring did required
Decentralized Identifier (DID)
Example:did:web:vasps.id:jxnl0411:at
The DID of the entity
transferIdstring uuid required
Example:01f09c55-9de0-42c5-874f-237dcb51fd9f
The transfer ID
Request body
Example request
{
"original": "did:web:agent-to-remove.example.com",
"reason": "Agent no longer participating"
}Response
Agent removal accepted
Example response
{
"message": "Agent removal accepted"
}