UCP Message Structure (Standard Request Format)

All API operations in Norsh use a standard request envelope, called a UCP message, transmitted in an array for batch processing.
Each API request must include the following core fields:

Path Parameter

network (required): Target network (main or test).

Body Parameters (`application/vnd.ucp+json`)

Each message in the array must include:

command (string, required): The command to execute (e.g., address.register, keys.generate, etc).

version (integer, optional): Protocol version (usually 1).

parameters (object, optional):

xid (string, optional): External identifier for tracking or correlating the request (required for batch input).

nonce (string, optional): Value to prevent replay attacks or enforce uniqueness.

(other command-specific fields, as required)

publicKey (string, required): Base64-encoded public key used for the operation.

signature (string, required): Cryptographic signature (Base64) of the request payload, generated with the corresponding private key.
Used to verify the authenticity and integrity of the message.

Batch

Multiple UCP messages can be submitted in a single request. Each message is processed independently and returns an individual result.

UCP Message Structure (Standard Request Format)

Path Parameter#

Body Parameters (application/vnd.ucp+json)#

Batch#

Path Parameter

Body Parameters (`application/vnd.ucp+json`)

Batch