InitiateTransaction

Initiate a new transaction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
details
object
required

Input to create the transaction.

Choose one of the available messages.

string
enum

Generic priority enum for transactions.
Translates to network specific priority values.

  • LOW: Low priority.
  • NORMAL: Normal priority. The default value.
  • HIGH: High priority.
Allowed:
string

A note to attach to the transaction.

This note will be visible to all vault members.

designatedSigners
array of strings

If the transaction is designated to be signed by a specific signer, this field should be set.

Format: users/{email} or users/{id}

Example: ["users/[email protected]"] or ["users/a3e4f5"]

designatedSigners
boolean

If set to true, the transaction will be validated but not created.

string

An optional request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.

The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).

string

A client-provided identifier for the transaction.

Must be unique per vault. Can be used to correlate the transaction
with an entity in an external system.

annotations
object

Arbitrary client-defined key/value metadata to attach to the transaction.

Utila stores these values but never interprets them. They are surfaced
read-only on the resulting Transaction to anyone who can view it (custodians,
partners, integrations), so multiple integrations can namespace their own
keys without colliding.

This field is meant for small, lightweight metadata rather than bulk data:

  • At most 64 entries.
  • Keys: at most 256 characters.
  • Total serialized size (UTF-8): at most 64 KiB (65,536 bytes).

Avoid storing secrets or sensitive data here, since the data is visible to
other parties who can view the transaction. For anything larger than the
size limit, consider keeping it in your own system and referencing it by an ID.

boolean

Run a simulation against a blockchain node to get the estimated execution results of the transaction like balance changes.

date-time

The expiration time of the transaction.

Example: 2025-06-10T12:30:05Z

boolean

Include referenced resources in the response.

Response

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