Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfers

Replace an agent in a transfer

Replaces an existing agent in a transfer with a new agent. The caller must be the transfer initiator, a gateway, or have a relationship with the agent being replaced.

post/entities/{entityDID}/tx/{transferId}/agents/replace

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

originalstring required

DID of the agent to be replaced

Example request

{
  "original": "did:web:old-agent.example.com",
  "replacement": {
    "@id": "did:web:new-agent.example.com",
    "role": "VASP",
    "for": "did:web:beneficiary.example.com"
  }
}

Response

Agent replacement accepted

messagestring

Example response

{
  "message": "Agent replacement accepted"
}