YaqeenDocs
Back to Yaqeen

Reference

API reference

Every operation of the Yaqeen API, grouped by area, generated from the OpenAPI file.

The reference is generated from openapi.yaml: 196 operations in 36 groups. Every endpoint needs a signed-in person or an API key unless the guides say otherwise.

Appeals#

1 operation.

GET/api/v1/appeals/#

Every appeal of the organization for staff: open ones first, oldest waiting first.

Parameters: status (query, string)

Approvals#

6 operations.

GET/api/v1/approvals/#

The requests waiting for a second person, and past ones. Only this organization's.

Parameters: status (query, string)

GET/api/v1/approvals/settings/#

When a change needs a second person. Everyone on staff can read it, only an admin can change it.

PUT/api/v1/approvals/settings/#

When a change needs a second person. Everyone on staff can read it, only an admin can change it.

Parameters: body ApprovalSettingsInputRequest

GET/api/v1/approvals/{approval_id}/#

Approvals read

Parameters: approval_id (path, required, string)

POST/api/v1/approvals/{approval_id}/cancel/#

Approvals cancel

Parameters: approval_id (path, required, string)

POST/api/v1/approvals/{approval_id}/decision/#

Approvals decide

Parameters: approval_id (path, required, string); body ApprovalDecisionInputRequest

Assistant#

15 operations.

POST/api/v1/assistant/act/#

Assistant act

Parameters: body ActInRequest

POST/api/v1/assistant/chat/#

Assistant chat

Parameters: body ChatInRequest

POST/api/v1/assistant/chat/stream/#

The same reply as `chat/`, sent as one JSON event per line while it is made.

Parameters: body ChatInRequest

GET/api/v1/assistant/chats/#

Assistant chats list

GET/api/v1/assistant/chats/{chat_id}/#

Assistant chats read

Parameters: chat_id (path, required, string)

PATCH/api/v1/assistant/chats/{chat_id}/#

Assistant chats rename

Parameters: chat_id (path, required, string); body PatchedChatRenameInRequest

DELETE/api/v1/assistant/chats/{chat_id}/#

Assistant chats delete

Parameters: chat_id (path, required, string)

POST/api/v1/assistant/feedback/#

Assistant feedback

Parameters: body FeedbackInRequest

GET/api/v1/assistant/me/#

Assistant me

POST/api/v1/assistant/run/#

Runs one tool by name with no brain, for the tool menu and for tests. A change still returns a card.

Parameters: body RunInRequest

GET/api/v1/assistant/teammates/#

Who a reviewer or admin can hand a chat to from YQN: active staff of the same organization. The hand-over itself

GET/api/v1/assistant/tools/#

The tools this person may use, read from the tools themselves, with their groups and input forms.

Parameters: language (query, string)

GET/api/v1/assistant/traces/#

Recent replies, newest first: how long they took and which tools ran. Admins only.

Parameters: limit (query, integer), outcome (query, string), tool (query, string)

GET/api/v1/assistant/traces/{trace_id}/#

One reply's steps. The person who got the reply, or an admin. Anyone else gets "not found".

Parameters: trace_id (path, required, string)

GET/api/v1/assistant/usage/#

Counts only: how many replies, which brain, which tools. Never a message.

Audit#

2 operations.

GET/api/v1/audit/#

Audit list

GET/api/v1/audit/export/#

The audit log for a date range with the hashes that chain it, so a receiver can check nothing was removed.

Auth#

10 operations.

GET/api/v1/auth/csrf/#

Auth csrf

POST/api/v1/auth/google/#

Sign in with a Google ID token. A new person gets an account that waits for an admin: 403 account_pending. 400 policy_not_accepted when the Google account is new and `accepted_policy` is not the current version (`GET /privacy/policy/`). 404 google_off when Google sign-in is not set up. 503 google_unavailable when Google's keys cannot be fetched.

Parameters: body GoogleInputRequest

POST/api/v1/auth/invite/accept/#

No sign-in: the one-time token is the credential. Limited like a login.

Parameters: body AcceptInputRequest

POST/api/v1/auth/login/#

Auth login

Parameters: body LoginInputRequest

POST/api/v1/auth/logout-everywhere/#

End every session of the signed-in person, on every device, and this one too. Use it when a device is lost or a password may have leaked.

POST/api/v1/auth/logout/#

Auth logout

GET/api/v1/auth/me/#

Auth me

POST/api/v1/auth/password/#

Auth password change

Parameters: body PasswordChangeInputRequest

POST/api/v1/auth/signup/#

Ask for an account. The account is switched off until an admin approves it, and this does not sign the person in. 409 username_taken, 400 invalid_username, bad_email or invalid (the password rules), 400 policy_not_accepted when `accepted_policy` is not the current version (`GET /privacy/policy/`), 503 signups_paused when too many accounts are already waiting.

Parameters: body SignupInputRequest

Cases#

8 operations.

GET/api/v1/cases/#

Cases list

Parameters: assigned_to (query, string), status (query, string)

GET/api/v1/cases/{case_id}/#

Cases detail

Parameters: case_id (path, required, string)

POST/api/v1/cases/{case_id}/assign/#

Cases assign

Parameters: case_id (path, required, string); body CaseAssignInputRequest

GET/api/v1/cases/{case_id}/export/#

Cases export

Parameters: as (query, string), case_id (path, required, string)

GET/api/v1/cases/{case_id}/notes/#

Cases notes list

Parameters: case_id (path, required, string)

POST/api/v1/cases/{case_id}/notes/#

Cases notes add

Parameters: case_id (path, required, string); body CaseNoteInputRequest

GET/api/v1/cases/{case_id}/outcome/#

Cases outcomes list

Parameters: case_id (path, required, string)

POST/api/v1/cases/{case_id}/outcome/#

Cases outcomes add

Parameters: case_id (path, required, string); body OutcomeInputRequest

Devices#

3 operations.

GET/api/v1/devices/#

A merchant's phones. Register one to receive push messages; the token is never returned.

POST/api/v1/devices/#

A merchant's phones. Register one to receive push messages; the token is never returned.

Parameters: body DeviceInputRequest

DELETE/api/v1/devices/{device_id}/#

Devices remove

Parameters: device_id (path, required, string)

Holds#

15 operations.

GET/api/v1/holds/#

Holds list

Parameters: status (query, string)

POST/api/v1/holds/appeals/{appeal_id}/decision/#

Holds appeal decide

Parameters: appeal_id (path, required, string); body AppealDecisionInputRequest

GET/api/v1/holds/appeals/{appeal_id}/documents/#

GET lists the uploaded files. POST asks to upload one and returns a signed form for the browser.

Parameters: appeal_id (path, required, string)

POST/api/v1/holds/appeals/{appeal_id}/documents/#

GET lists the uploaded files. POST asks to upload one and returns a signed form for the browser.

Parameters: appeal_id (path, required, string); body DocumentInputRequest

POST/api/v1/holds/appeals/{appeal_id}/documents/{document_id}/confirm/#

Holds document confirm

Parameters: appeal_id (path, required, string), document_id (path, required, string)

GET/api/v1/holds/appeals/{appeal_id}/documents/{document_id}/download/#

Holds document download

Parameters: appeal_id (path, required, string), document_id (path, required, string)

POST/api/v1/holds/bulk-decision/#

Apply one decision to up to 50 holds. Big holds still wait for a second person, one by one. Send an

Parameters: body BulkDecisionInputRequest

GET/api/v1/holds/{hold_id}/#

Holds detail

Parameters: hold_id (path, required, string)

GET/api/v1/holds/{hold_id}/appeals/#

GET lists a hold's appeals. POST files a new one (staff, or the merchant that owns the hold).

Parameters: hold_id (path, required, string)

POST/api/v1/holds/{hold_id}/appeals/#

GET lists a hold's appeals. POST files a new one (staff, or the merchant that owns the hold).

Parameters: hold_id (path, required, string); body AppealInputRequest

GET/api/v1/holds/{hold_id}/case/#

The parties around a held payout. Staff only: it shows other parties, which a merchant must not see.

Parameters: hold_id (path, required, string)

GET/api/v1/holds/{hold_id}/chats/#

The store's chat lines that ask the buyer to pay outside the platform, on the orders behind one hold.

Parameters: hold_id (path, required, string)

POST/api/v1/holds/{hold_id}/decision/#

Holds decide

Parameters: hold_id (path, required, string); body DecisionInputRequest

GET/api/v1/holds/{hold_id}/explain/#

Holds explain

Parameters: hold_id (path, required, string)

GET/api/v1/holds/{hold_id}/orders/#

The orders in the payout's window. `customer_id` and `device_id` narrow them to what a reason points at.

Parameters: customer_id (query, string), device_id (query, string), hold_id (path, required, string), reason (query, string)

Ingest#

4 operations.

POST/api/v1/ingest/connect/#

Load rows in the customer's own columns through a saved mapping. Defaults to a dry run that writes nothing.

Parameters: body ConnectInputRequest

POST/api/v1/ingest/feed/#

A live feed of orders or payouts, as JSON rows. Upserts by external id. Admins only.

Parameters: body FeedInputRequest

GET/api/v1/ingest/mappings/#

Saved column mappings, one per customer export. Admins only.

POST/api/v1/ingest/mappings/#

Saved column mappings, one per customer export. Admins only.

Parameters: body MappingInputRequest

Intake#

5 operations.

GET/api/v1/intake/#

Intake list

Parameters: status (query, string)

POST/api/v1/intake/#

Intake submit

Parameters: body ApplicationInputRequest

GET/api/v1/intake/{application_id}/#

Intake read

Parameters: application_id (path, required, string)

POST/api/v1/intake/{application_id}/decision/#

Intake decide

Parameters: application_id (path, required, string); body IntakeDecisionInputRequest

POST/api/v1/intake/{application_id}/document/#

Intake document

Parameters: application_id (path, required, string); body IntakeDocumentInputRequest

Jobs#

2 operations.

GET/api/v1/jobs/#

Jobs list

GET/api/v1/jobs/{job_id}/#

Jobs detail

Parameters: job_id (path, required, string)

Keys#

4 operations.

GET/api/v1/keys/#

Keys list

POST/api/v1/keys/#

Keys create

Parameters: body KeyInputRequest

DELETE/api/v1/keys/{key_id}/#

Keys revoke

Parameters: key_id (path, required, string)

POST/api/v1/keys/{key_id}/rotate/#

Keys rotate

Parameters: key_id (path, required, string); body KeyRotateInputRequest

Mcp#

3 operations.

POST/api/v1/mcp/#

One MCP JSON-RPC message (Streamable HTTP, JSON responses, no sessions). Sign in with an OAuth token or an API key that has the `mcp` scope. Read-only tools only.

GET/api/v1/mcp/settings/#

An admin reads or changes the organization's MCP policy.

PUT/api/v1/mcp/settings/#

Switch MCP off or on for the organization, and choose whether results have personal values swapped for placeholders. Both fields are required. Sessions only: an API key cannot change it.

Parameters: body SettingsRequest

Notifications#

3 operations.

GET/api/v1/notifications/#

Notifications list

Parameters: unread (query, boolean)

POST/api/v1/notifications/read-all/#

Notifications read all

POST/api/v1/notifications/{notification_id}/read/#

Notifications read

Parameters: notification_id (path, required, string)

Onboarding#

1 operation.

GET/api/v1/onboarding/#

Onboarding checklist

Ops#

13 operations.

GET/api/v1/ops/audit-verify/#

Recompute the audit hashes and report any breaks.

GET/api/v1/ops/confidence/#

The headline numbers of the shipped detector for the people who review holds: no pattern or scorer detail.

GET/api/v1/ops/health/#

What an admin needs to see at a glance: failed jobs, a stuck worker, a broken audit chain.

GET/api/v1/ops/hold-line/#

The model's score for every stored payout, in bins, so a hold line can be chosen against real counts.

GET/api/v1/ops/importance/#

How much each model feature moves the score across the evaluation worlds. For the people who review holds.

GET/api/v1/ops/kpis/#

How the review team is doing. Reviewers see team numbers. Only admins also get a row per person.

Parameters: days (query, integer)

GET/api/v1/ops/label-audit/#

A fixed sample of the month's conclusions for a second reviewer to check. Counts how often they disagree.

Parameters: month (query, string)

POST/api/v1/ops/label-audit/{outcome_id}/#

Ops label audit check

Parameters: outcome_id (path, required, string); body AuditCheckInputRequest

GET/api/v1/ops/learning/#

What feedback the product holds, which of it the policy lets a retrain use, and the last candidate run.

GET/api/v1/ops/monitoring/#

Weekly activity for the monitoring screen: holds placed and approved, appeals, and wrong holds per 100 stores.

Parameters: weeks (query, integer)

GET/api/v1/ops/policy-history/#

Policy history

GET/api/v1/ops/releases/#

Released holds, and who released each one: the expiry job, or a named reviewer. Use ?by=system or ?by=person.

GET/api/v1/ops/weekly-report/#

The numbers behind the weekly summary, for a screen or an export.

Owners#

2 operations.

GET/api/v1/owners/#

Owners are staff-only. A merchant sees its own owner through the store endpoints.

GET/api/v1/owners/{owner_id}/#

Owners detail

Parameters: owner_id (path, required, string)

Payouts#

2 operations.

GET/api/v1/payouts/#

Payouts list

GET/api/v1/payouts/{payout_id}/#

Payouts detail

Parameters: payout_id (path, required, string)

Policy#

10 operations.

GET/api/v1/policy/#

GET returns the active policy. PUT saves a new version (admins only). The body is the whole policy.

PUT/api/v1/policy/#

GET returns the active policy. PUT saves a new version (admins only). The body is the whole policy.

GET/api/v1/policy/proposals/#

Policy proposals list

POST/api/v1/policy/proposals/#

Policy proposals create

Parameters: body ProposalInputRequest

POST/api/v1/policy/proposals/rollback/#

Policy rollback

GET/api/v1/policy/proposals/{proposal_id}/#

Policy proposals read

Parameters: proposal_id (path, required, string)

POST/api/v1/policy/proposals/{proposal_id}/backtest/#

Policy proposals backtest

Parameters: proposal_id (path, required, string); body ProposalBacktestInputRequest

POST/api/v1/policy/proposals/{proposal_id}/promote/#

Policy proposals promote

Parameters: proposal_id (path, required, string)

POST/api/v1/policy/proposals/{proposal_id}/shadow/start/#

Policy proposals shadow start

Parameters: proposal_id (path, required, string)

POST/api/v1/policy/proposals/{proposal_id}/shadow/stop/#

Policy proposals shadow stop

Parameters: proposal_id (path, required, string)

Portal#

8 operations.

GET/api/v1/portal/export/#

Portal export

GET/api/v1/portal/holds/{hold_id}/messages/#

The thread about one hold. A merchant sees its own holds. Reviewers and admins can answer.

Parameters: hold_id (path, required, string)

POST/api/v1/portal/holds/{hold_id}/messages/#

The thread about one hold. A merchant sees its own holds. Reviewers and admins can answer.

Parameters: hold_id (path, required, string); body MessageInputRequest

GET/api/v1/portal/holds/{hold_id}/timeline/#

Portal timeline

Parameters: hold_id (path, required, string)

GET/api/v1/portal/ledger/#

Portal ledger

Parameters: months (query, integer)

GET/api/v1/portal/preferences/#

Portal preferences get

PUT/api/v1/portal/preferences/#

Portal preferences update

Parameters: body PreferencesIORequest

GET/api/v1/portal/summary/#

Portal summary

Privacy#

7 operations.

POST/api/v1/privacy/me/requests/#

A merchant asks about their own data. A reviewer or admin answers it from the normal request list.

Parameters: body MyRequestInputRequest

GET/api/v1/privacy/policy/#

No sign-in. The version of the privacy notice and terms that sign-up asks a person to accept.

GET/api/v1/privacy/requests/#

Privacy requests list

POST/api/v1/privacy/requests/#

Privacy requests log

Parameters: body RequestInputRequest

POST/api/v1/privacy/requests/{request_id}/close/#

Answers a request. For access the response carries the copy, once: it is not stored.

Parameters: request_id (path, required, string); body PrivacyCloseInputRequest

Queue#

6 operations.

GET/api/v1/queue/#

What to review next. Highest priority first, with your own claimed items on top.

Parameters: limit (query, integer)

POST/api/v1/queue/next/#

Queue next

GET/api/v1/queue/settings/#

Queue settings get

PUT/api/v1/queue/settings/#

Queue settings update

Parameters: body QueueSettingsRequest

GET/api/v1/queue/workload/#

Queue workload

POST/api/v1/queue/{hold_id}/release/#

Queue release

Parameters: hold_id (path, required, string)

Reserves#

10 operations.

GET/api/v1/reserves/#

Reserves list

Parameters: status (query, string), store (query, string)

POST/api/v1/reserves/#

Reserves create

Parameters: body ReserveInputRequest

GET/api/v1/reserves/disputes/#

Disputes list

Parameters: status (query, string)

POST/api/v1/reserves/disputes/#

Disputes open

Parameters: body DisputeInputRequest

GET/api/v1/reserves/disputes/mine/#

Disputes mine

POST/api/v1/reserves/disputes/{dispute_id}/decide/#

Disputes decide

Parameters: dispute_id (path, required, string); body DecideInputRequest

POST/api/v1/reserves/disputes/{dispute_id}/respond/#

Disputes respond

Parameters: dispute_id (path, required, string); body RespondInputRequest

GET/api/v1/reserves/mine/#

What is held back from the merchant's own stores, and until when.

GET/api/v1/reserves/stores/{store_id}/#

Reserves store position

Parameters: store_id (path, required, string)

POST/api/v1/reserves/{reserve_id}/close/#

Reserves close

Parameters: reserve_id (path, required, string); body ReserveCloseInputRequest

Risk#

3 operations.

GET/api/v1/risk/reviews-due/#

Risk reviews due

GET/api/v1/risk/stores/{store_id}/#

What we know about one store, why it is in its band, and when someone should look again.

Parameters: store_id (path, required, string)

POST/api/v1/risk/stores/{store_id}/review/#

Risk store review

Parameters: store_id (path, required, string); body ReviewInputRequest

Rules#

4 operations.

GET/api/v1/rules/#

Rules list

POST/api/v1/rules/#

Rules save

Parameters: body RuleInputRequest

POST/api/v1/rules/backtest/#

Rules backtest

Parameters: body RuleBacktestInputRequest

POST/api/v1/rules/{key}/disable/#

Rules disable

Parameters: key (path, required, string)

Sandbox#

4 operations.

GET/api/v1/sandbox/#

Sandbox status

POST/api/v1/sandbox/#

Sandbox create

POST/api/v1/sandbox/reset/#

Sandbox reset

POST/api/v1/sandbox/seed/#

Sandbox seed

Scim#

5 operations.

GET/api/v1/scim/v2/Users#

Scim users list

POST/api/v1/scim/v2/Users#

Scim users create

GET/api/v1/scim/v2/Users/{user_id}#

Scim user read

Parameters: user_id (path, required, integer)

PATCH/api/v1/scim/v2/Users/{user_id}#

Scim user patch

Parameters: user_id (path, required, integer)

DELETE/api/v1/scim/v2/Users/{user_id}#

Scim user deactivate

Parameters: user_id (path, required, integer)

Scoring#

1 operation.

POST/api/v1/scoring/runs/#

Queue a scoring run. The worker runs it; poll /jobs/{id}/ for the result.

Parameters: body ScoringRunInputRequest

1 operation.

Stores#

2 operations.

GET/api/v1/stores/#

Stores list

GET/api/v1/stores/{store_id}/#

Stores detail

Parameters: store_id (path, required, string)

Suppressions#

4 operations.

GET/api/v1/suppressions/#

Suppressions list

Parameters: state (query, string)

POST/api/v1/suppressions/#

Suppressions create

Parameters: body SuppressionInputRequest

GET/api/v1/suppressions/expiring/#

Entries that end within 14 days, so someone decides to renew or let them lapse.

POST/api/v1/suppressions/{suppression_id}/revoke/#

Suppressions revoke

Parameters: suppression_id (path, required, string); body RevokeInputRequest

Trust#

4 operations.

GET/api/v1/trust/components/#

What the status page draws: every part, its state now, and 90 days of daily bars.

GET/api/v1/trust/controls/#

No sign-in: a buyer's team can read these before they are a customer.

GET/api/v1/trust/incidents/#

Trust incidents list

GET/api/v1/trust/status/#

No sign-in: a buyer's team can read these before they are a customer.

Usage#

5 operations.

GET/api/v1/usage/#

Usage report

GET/api/v1/usage/export/#

Usage export

Parameters: month (query, string)

GET/api/v1/usage/invoice-draft/#

Usage invoice draft

Parameters: month (query, string)

GET/api/v1/usage/plan/#

Plan get

PUT/api/v1/usage/plan/#

Plan update

Users#

10 operations.

GET/api/v1/users/#

GET lists accounts (not the system account). POST creates a reviewer or admin. Admins only.

Parameters: is_active (query, boolean), q (query, string), role (query, string)

POST/api/v1/users/#

GET lists accounts (not the system account). POST creates a reviewer or admin. Admins only.

Parameters: body StaffCreateInputRequest

GET/api/v1/users/invites/#

Invites list

POST/api/v1/users/invites/#

Invites create

Parameters: body InviteInputRequest

POST/api/v1/users/invites/{invite_id}/resend/#

Invites resend

Parameters: invite_id (path, required, string)

POST/api/v1/users/invites/{invite_id}/revoke/#

Invites revoke

Parameters: invite_id (path, required, string)

POST/api/v1/users/merchants/#

Create a merchant account linked to one owner. Admins only.

Parameters: body MerchantAccountInputRequest

PATCH/api/v1/users/{user_id}/#

Users update

Parameters: user_id (path, required, integer); body PatchedUserUpdateInputRequest

POST/api/v1/users/{user_id}/password/#

Users password reset

Parameters: user_id (path, required, integer); body PasswordResetInputRequest

Views#

3 operations.

GET/api/v1/views/#

Views list

POST/api/v1/views/#

Views create

Parameters: body ViewInputRequest

DELETE/api/v1/views/{view_id}/#

Views delete

Parameters: view_id (path, required, string)

Webhooks#

10 operations.

GET/api/v1/webhooks/#

Webhooks list

POST/api/v1/webhooks/#

Webhooks create

Parameters: body EndpointInputRequest

GET/api/v1/webhooks/deliveries/{delivery_id}/#

Webhooks delivery

Parameters: delivery_id (path, required, string)

POST/api/v1/webhooks/deliveries/{delivery_id}/replay/#

Webhooks replay

Parameters: delivery_id (path, required, string)

GET/api/v1/webhooks/events/#

Webhooks events

PATCH/api/v1/webhooks/{endpoint_id}/#

Webhooks update

Parameters: endpoint_id (path, required, string); body PatchedEndpointPatchRequest

DELETE/api/v1/webhooks/{endpoint_id}/#

Webhooks remove

Parameters: endpoint_id (path, required, string)

GET/api/v1/webhooks/{endpoint_id}/deliveries/#

Webhooks deliveries

Parameters: endpoint_id (path, required, string), event_type (query, string), status (query, string)

POST/api/v1/webhooks/{endpoint_id}/ping/#

Webhooks ping

Parameters: endpoint_id (path, required, string)

POST/api/v1/webhooks/{endpoint_id}/rotate-secret/#

Webhooks rotate secret

Parameters: endpoint_id (path, required, string)

Up Down to moveEnter to openEsc to close