GET/api/v1/check-user-role-limit

Check an amount against a member's role limit

Tests whether a proposed amount fits within a role's spending limit for one member, returning true when it does and changing nothing either way.

AccessRequires a permission in the workspaceMANAGE_ROLE

This answers the question "can this member move this much?". You name the role, the workspace, the member, and the amount, and Success comes back true when the amount fits within the role's limit for that member and false when it does not. Pass the role the member actually holds in that workspace, which GET /api/v1/get-users-from-workspace reports as RoleId beside their UUID. For your own headroom, use GET /api/v1/get-my-limits, which a member can call for themselves with Initiate Payment.

A role limit is separate from the vault's limit, and both apply to a movement: check the vault side with GET /api/v1/check-vault-limit. Policies are enforced before the signing stage, so a movement that breaches either limit is blocked and never reaches signers. See Vault policies.

A true result is not a reservation

This is a pre-flight check against the member's usage at the moment you ask. Nothing is held back for them, so their own next movement, or a cycle reset, can change the answer. Treat true as "this would be accepted now", not as a guarantee that a later proposal will pass.

Query parameters

role_idnumberrequired

The role whose limit to test against. Pass the role the member holds in this workspace.

workspace_idnumberrequired

The workspace the role belongs to. You must hold MANAGE_ROLE in it.

uuidnumberrequired

The member's user id, as returned in UUID by get-users-from-workspace.

amount_to_checkstringrequired

The amount to test against the role's limit, as a decimal string.

bash

curl "$SQRL_API/api/v1/check-user-role-limit?role_id=77&workspace_id=342&uuid=4021&amount_to_check=7500.00" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  role_id: "77",
  workspace_id: "342",
  uuid: "4021",
  amount_to_check: "7500.00",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/check-user-role-limit?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Success } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/check-user-role-limit", api_base))
    .query(&[
        ("role_id", "77"),
        ("workspace_id", "342"),
        ("uuid", "4021"),
        ("amount_to_check", "7500.00"),
    ])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"Success": true
}

Was this page helpful?