YaqeenDocs
Back to Yaqeen

Explanation

Roles

The four roles in Yaqeen, what each one can do, and how accounts are created and recovered.

Every account has one role. The role decides what the account can read and change. This page explains the roles and the rules for creating, switching off and recovering accounts. The full permission list is in Roles and permissions.

The four roles#

RoleWhoCan do
ReviewerStaff who check and decideRead holds, cases, stores, payouts and results. Add case notes. Decide holds and appeals, record an appeal for a merchant, submit new-store applications, assign and close cases, record case conclusions, set reserves, handle disputes and log privacy requests. See the KPIs, the decision log and the monitoring numbers. Run the simulator and policy backtests.
AdminStaff who run the systemEverything a reviewer can, plus policy, accounts, API keys, webhooks, scoring runs, data loads, plan limits and the sandbox.
MerchantA store ownerOnly the holds, payouts, messages, appeals, reserves and disputes of its own owner.
SystemThe scheduled jobsReleases approved holds when their end date passes. Cannot sign in.

A merchant does not see a hold until a reviewer has approved it, and never sees the score, reviewer names, internal notes or anything about another party.

Create staff accounts#

An admin invites staff with POST /api/v1/users/invites/. The invitee opens a one-time link and chooses their own username and password, so no admin ever sets or sees a password. A link works once and ends after 7 days. Only a hash of the link token is kept.

An admin can also create an account directly with POST /api/v1/users/, and a merchant account with POST /api/v1/users/merchants/. A merchant account belongs to exactly one owner.

Recover an account#

If someone forgets their password, an admin issues a one-time reset link with POST /api/v1/users/{id}/reset-link/. The token is shown once and works once. It ends after 60 minutes, and a new link ends any older one. The person then sets their own password at POST /api/v1/auth/password/reset/, with no sign-in needed. The audit log records that a link was issued and used, never the token.

A signed-in person can change their own password at POST /api/v1/auth/password/. Their other sessions end.

Limits on accounts#

  • Accounts are switched off, never deleted.
  • The last active admin cannot be removed or switched off.
  • Nobody can change their own role or switch themselves off.
  • Account changes need a second person by default.
  • Reviewers and admins can connect Claude or Codex, which acts with that person's role and can only read. Merchants cannot. See Connect Claude and Codex.
  • The assistant offers only what the signed-in role may use, and a change it proposes is a card that the same person must confirm.

Up Down to moveEnter to openEsc to close