Sign in

v1

latestOpenAPI 3.0.02026-07-22343639.7 KB
registry

Verify the outcome of a transfer of Registry Utility assets on Canton.

Given an UpdateID and a Transfer Object, the service looks up the corresponding ledger transaction and verifies the transfer details against the on-chain events.

The response status indicates the transfer outcome:

  • Success: The transfer was executed in the referenced transaction
  • Pending: The transfer instruction has been created but not yet settled
  • Failure: The transfer instruction was rejected or withdrawn by one of the parties

If none of the above conditions are met, if the provided transfer details do not match the on-chain data, or if the original TransferInstruction contract cannot be retrieved, a 400 is returned. No further diagnostic information is included in the error response to prevent unintended disclosure of sensitive ledger data.

post/api/utilities/v0/registry/transfer/v0/proof

Request body

updateIdstring required

For the two-step transfer workflow, specifies the most recent UpdateId. If the transfer has completed its second step (accept, reject, or withdraw), use the UpdateId associated with that action. Otherwise, use the UpdateId from the initial transfer offer.

Example request

{
  "transfer": {
    "amount": "1.0000000000"
  }
}

Response

Transfer proof verified. The status field indicates the transfer outcome (Success, Pending, or Failure). See the endpoint description for details.

status'Success' | 'Failure' | 'Pending' required

The status of the transfer proof verification:

  • Success: The proof is verified and the transfer was successfully concluded
  • Failure: The proof is verified, but the transfer did not successfully conclude.
  • Pending: The transaction is still in progress (e.g., a transfer offer has been sent but not yet accepted in a two-step flow).