Reference
API reference
Base URL https://www.authentify.bz. JSON in and out. The key's prefix (aut_sandbox_ or aut_production_) selects the environment.
The agent-facing and end-user calls are also in /openapi.json. Each group below links to its guide, which has request and response examples.
Authentication
| Label | Meaning |
|---|
agent | The agent's key as x-api-key, or an access token as Authorization: Bearer. |
account | Your account key as x-api-key from your backend, or a signed-in dashboard session. Agent keys are refused. |
session | A signed-in dashboard session with the right team permission. |
signed-in person | Only a person signed in to the dashboard. No key of any kind works. |
Authorization
Guide →
| Method | Path | Auth | What it does |
|---|
POST | /api/v2/authorize | agent | Ask whether an agent may take an action. |
GET | /api/v2/authorization-requests | account | List requests (?session_id= for one run). |
GET | /api/v2/authorization-requests/:id | account | One request as recorded: checks, votes, outcome. |
POST | /api/v2/authorization-requests/:id/outcome | agent or account | Report what happened after a decision. |
POST | /api/v2/authorization-requests/:id/decision-token | agent | Single-use proof of an approved action, for one audience. |
POST | /api/v1/decision-tokens/verify | any key | Check a decision token, its context, and whether its authority is still live. |
GET | /api/v2/authorization-requests/:id/witness | account | The request’s RFC 3161 witness. |
Human review
Guide →
| Method | Path | Auth | What it does |
|---|
GET | /api/v2/approval-requests | account | List reviews (?status=pending). |
GET | /api/v2/approval-requests/:id | account | One review, with its votes. |
POST | /api/v2/approval-requests/:id/approve | signed-in person | Vote to approve. API keys are refused. |
POST | /api/v2/approval-requests/:id/reject | signed-in person | Vote to reject. API keys are refused. |
End users
Guide →
| Method | Path | Auth | What it does |
|---|
POST | /api/v1/consent-sessions | account (Bearer) | Start a consent request for one person and one agent. |
GET | /api/v1/consent-sessions/:id/status | session id | Where a consent session stands. |
POST | /api/v1/consent-sessions/:id/confirm-auth | account (Bearer) | Confirm step-up sign-in before consent is granted. |
POST | /api/v2/approval-requests/:id/end-user-link | account | Single-use link for the person to decide one escalated action. |
POST | /api/v2/end-users/:endUserId/portal-link | account | One-hour link to the person’s "my agents" page. |
Agents & credentials
Guide →
| Method | Path | Auth | What it does |
|---|
POST | /api/v1/agents | account | Create an agent; returns its key once. |
GET | /api/v1/agents?customer_id=… | account | List agents. |
POST | /api/v1/agents/:id/update | account | Change actions, scope, rate limit, domain, end-user settings. |
POST | /api/v1/agents/:id/revoke | account | Stop one agent. |
GET | /api/v1/api-keys | account | List keys. |
POST | /api/v1/api-keys/:id/rotate | account | New key, old one revoked. |
POST | /api/v1/api-keys/:id/revoke | account | Revoke one key. |
POST | /api/v1/oauth/token | key id + key | Short-lived access token (client_credentials or token exchange). |
GET / POST | /api/v1/identity-providers | session | List or register an identity provider (Entra ID). |
POST | /api/v1/identity-providers/:id/test | session | Check a real user token against a registration. |
PUT / DELETE | /api/v1/account/kill-switch | session | Turn the account kill switch on or off. |
Rules & policy
Guide →
| Method | Path | Auth | What it does |
|---|
GET / POST | /api/v1/rules | account | List or create rules. |
POST | /api/v1/rules/:id/update | account | Change a rule. |
POST | /api/v1/rules/:id/delete | account | Delete a rule. |
GET / POST | /api/v1/violation-policy | account | Auto-revoke or notify on scope violations. |
GET / POST | /api/v1/approval-sla-action | account | Notify or deny when a review’s SLA runs out. |
GET / POST | /api/v1/change-approval-policy | account | Require a second person for risk-raising agent and rule changes. |
Evidence & audit
Guide →
| Method | Path | Auth | What it does |
|---|
GET | /api/v1/audit-logs?customer_id=… | account | Sealed audit records. |
GET | /api/v1/audit-integrity?customer_id=… | account | Re-verify the chain now. |
GET | /api/v1/audit-checkpoints | account | Past signed checkpoints. |
POST | /api/v1/audit-checkpoints/verify | account | Check the log against a checkpoint you stored. |
GET | /api/v1/compliance-exports/evidence-bundle | session | Offline-verifiable evidence bundle. |
GET | /.well-known/jwks.json | none | Public keys for every token and signature Authentify issues. |
Webhooks
Guide →
| Method | Path | Auth | What it does |
|---|
GET / POST | /api/v1/webhook-endpoints | session | List or register endpoints. |
GET / DELETE | /api/v1/webhook-endpoints/:id | session | One endpoint and its deliveries, or disable it. |
POST | /api/v1/webhook-endpoints/:id/test | session | Send a signed ping. |
Errors
| Status | Meaning |
|---|
| 200 | Success. For /v2/authorize, always read decision: a deny is still a 200. |
| 400 | The request is malformed; the body says which field. |
| 401 | Missing or invalid key or token. |
| 403 | The credential is valid but not allowed here (for example an agent key on an account call). |
| 404 | Not found in your account and environment. |
| 429 | Too many failed attempts from this client; slow down. |
Sandbox and production are separate
Each has its own agents, keys, records, webhooks and audit chain. Nothing crosses between them.