v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfers

Authorize a transfer

Authorizes a transfer to proceed. Optionally accepts a settlement address and memo tag. Can be forced with the force query parameter to bypass certain checks, or use ignoreFlags to ignore flag policies.

post/entities/{entityDID}/tx/{transferId}/authorize

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

Query parameters

forcestring

Force the action even if checks fail

ignoreFlagsstring

Comma-separated list of flags to ignore

Request body

settlementAddressstring
memoTagstring

Example request

{
  "settlementAddress": "eip155:1:0x1234567890123456789012345678901234567890",
  "memoTag": "memo-123"
}

Response

Transfer authorization accepted

messagestring required

Example response

{
  "message": "Transfer authorization accepted"
}