Developers › API reference

Firm API

The firm and its settings.

Objects

The firm and its settings: approval thresholds (order value, percent of an account), the override threshold, AI on or off and its retention, surveillance parameters, the "stuck" time, single-Compliance sign-off, legacy keys, and API limits.

Notes

Changing settings needs firm:write (an Admin's token) and If-Match. Every change is in the event log. The default workflow rules follow the thresholds at once.

Endpoints

CallWhat it doesScope
GET/firmThe firm and its settingsfirm:read
PATCH/firmChange settings (If-Match)firm:write