Skip to main content
POST
/
v1
/
query
/
get-update-users-role-payload-passkey
Get update users role payload
curl --request POST \
  --url https://api.example.com/v1/query/get-update-users-role-payload-passkey \
  --header 'Content-Type: application/json' \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "role": "root",
  "userIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}
'
{
  "bodyToSign": {
    "type": "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM",
    "timestampMs": "<string>",
    "organizationId": "d107c1e1-766a-4091-802c-de61a3973e91",
    "parameters": {
      "threshold": 1,
      "userIds": [
        "<string>"
      ]
    }
  }
}

Authorizations

​
X-Pubkey, X-Timestamp, X-Signature
string
header
required

Headers

​
X-Pubkey
string
required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

​
X-Timestamp
string
required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

​
X-Signature
string
required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Body

application/json

Body to update users' roles within a Byzantine account

Request body for updating users' roles within a Byzantine account

​
accountId
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
role
enum<string>
required

Role of a user in an account.

Available options:
root,
admin,
view,
self_custodial,
beneficiary
Example:

"root"

​
userIds
string<uuid>[]
required

The unique identifiers of users beeing promoted / demoted.

A UUID string

Response

Payload to sign created successfully

​
bodyToSign
object
required

The object that needs to be signed by the end user to update the root quorum of a Byzantine account.