YaqeenDocs
Back to Yaqeen

Reference

Settings

The limits an admin can change through the API, one set for each organization.

This page lists the settings that an admin changes through the API, one set for each organization. Anyone with a staff role can read them. Only an admin can change them. Every change is written to the audit log.

In the dashboard, Settings shows the queue limits in plain sentences under Review rules, and an admin changes them there. An admin also lowers the plan limits under Plan limits and switches Claude and Codex connections under AI assistants. The hold policy and the second-person limits are on the Policy page.

Hold policy#

GET /api/v1/policy/ shows the active policy. PUT /api/v1/policy/ saves a new version. Send the whole policy as a JSON object. A policy change waits for a second admin when the setting policy_changes is on and another admin exists.

FieldDefaultRule
hold_days.default8Days a hold lasts after the deposit date.
hold_days.min, hold_days.max2, 8Must satisfy 1 <= min <= default <= max <= 30.
appeal_days14Appeal window after approval, 1 to 60 days.
scoring.review_days2Days a review is expected to take.

The policy also holds detection fields that Yaqeen sets with you. Read the policy with GET, change only the fields above, and send the other fields back unchanged. The first policy is Yaqeen's default. Each save creates a new numbered version, and only one version is active. A version that fails the rules, such as a review_days that leaves no time before the deposit, is refused with 400 bad_policy.

Review queue#

GET and PUT /api/v1/queue/settings/.

FieldDefaultRangeMeaning
review_hours481 to 720How long a recommended hold may wait before Yaqeen raises an alert.
claim_minutes305 to 240How long one person keeps an item.
max_claims31 to 20Items one person may hold at once.

Second-person approval#

GET and PUT /api/v1/approvals/settings/.

FieldDefaultRuleMeaning
hold_amount5,000 SARAbove 0A hold or reserve above this amount needs a second person.
owner_daily_amount10,000 SARAbove 0Holds on one owner add up over 24 hours. Above this total, a second person is needed.
policy_changestrueBooleanPolicy changes need a second admin.
user_changestrueBooleanAccount changes need a second admin.
suppressionstrueBooleanSuppressions and rules that skip payouts need a second person.
expiry_hours241 to 168A waiting request ends after this time.

Plan limits#

GET and PUT /api/v1/usage/plan/. A limit of 0 means no limit. An admin can only lower a limit: the API calls limit takes a whole number from 1 to the plan's own limit, and anything else answers 400 bad_limit or 403 over_plan. To raise a limit, contact us.

FieldDefaultMeaning
daily_api_calls50,000Calls a day for the organization, from all keys.
monthly_decisions0Hold decisions a month.
monthly_scoring_runs0Scoring runs a month.
base_fee, price_per_decision, price_per_scoring_run, price_per_1000_calls0Prices in SAR, set by Yaqeen for your agreement. You can read them. PUT with a price field answers 403 operator_only. All zero means nothing is charged.

MCP for Claude and Codex#

GET and PUT /api/v1/mcp/settings/. Only a signed-in admin can change it. An API key cannot. Send both fields on a PUT. Each change is written to the audit log as mcp.settings.

FieldDefaultMeaning
enabledtrueWhen false, every key and token is refused at the MCP address, and new sign-ins from Claude or Codex are refused.
redactfalseWhen true, names, usernames and contact values in each result become placeholders.

API keys#

Each key has its own rate_per_minute (1 to 6000, default 120) and a life of 1 to 365 days. See Authentication.

Service settings#

Alert email and chat alerts, push messages to merchants, document storage for appeals, sign in with Google, retention periods and the assistant's language model are set by Yaqeen for your organization. They are not available through the API. Ask your Yaqeen contact to change one.

Up Down to moveEnter to openEsc to close