Skip to Content
Documentation menu

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

LabelMeaning
agentThe agent's key as x-api-key, or an access token as Authorization: Bearer.
accountYour account key as x-api-key from your backend, or a signed-in dashboard session. Agent keys are refused.
sessionA signed-in dashboard session with the right team permission.
signed-in personOnly a person signed in to the dashboard. No key of any kind works.

Authorization

Guide →

MethodPathAuthWhat it does
POST/api/v2/authorizeagentAsk whether an agent may take an action.
GET/api/v2/authorization-requestsaccountList requests (?session_id= for one run).
GET/api/v2/authorization-requests/:idaccountOne request as recorded: checks, votes, outcome.
POST/api/v2/authorization-requests/:id/outcomeagent or accountReport what happened after a decision.
POST/api/v2/authorization-requests/:id/decision-tokenagentSingle-use proof of an approved action, for one audience.
POST/api/v1/decision-tokens/verifyany keyCheck a decision token, its context, and whether its authority is still live.
GET/api/v2/authorization-requests/:id/witnessaccountThe request’s RFC 3161 witness.

Human review

Guide →

MethodPathAuthWhat it does
GET/api/v2/approval-requestsaccountList reviews (?status=pending).
GET/api/v2/approval-requests/:idaccountOne review, with its votes.
POST/api/v2/approval-requests/:id/approvesigned-in personVote to approve. API keys are refused.
POST/api/v2/approval-requests/:id/rejectsigned-in personVote to reject. API keys are refused.

End users

Guide →

MethodPathAuthWhat it does
POST/api/v1/consent-sessionsaccount (Bearer)Start a consent request for one person and one agent.
GET/api/v1/consent-sessions/:id/statussession idWhere a consent session stands.
POST/api/v1/consent-sessions/:id/confirm-authaccount (Bearer)Confirm step-up sign-in before consent is granted.
POST/api/v2/approval-requests/:id/end-user-linkaccountSingle-use link for the person to decide one escalated action.
POST/api/v2/end-users/:endUserId/portal-linkaccountOne-hour link to the person’s "my agents" page.

Agents & credentials

Guide →

MethodPathAuthWhat it does
POST/api/v1/agentsaccountCreate an agent; returns its key once.
GET/api/v1/agents?customer_id=…accountList agents.
POST/api/v1/agents/:id/updateaccountChange actions, scope, rate limit, domain, end-user settings.
POST/api/v1/agents/:id/revokeaccountStop one agent.
GET/api/v1/api-keysaccountList keys.
POST/api/v1/api-keys/:id/rotateaccountNew key, old one revoked.
POST/api/v1/api-keys/:id/revokeaccountRevoke one key.
POST/api/v1/oauth/tokenkey id + keyShort-lived access token (client_credentials or token exchange).
GET / POST/api/v1/identity-providerssessionList or register an identity provider (Entra ID).
POST/api/v1/identity-providers/:id/testsessionCheck a real user token against a registration.
PUT / DELETE/api/v1/account/kill-switchsessionTurn the account kill switch on or off.

Rules & policy

Guide →

MethodPathAuthWhat it does
GET / POST/api/v1/rulesaccountList or create rules.
POST/api/v1/rules/:id/updateaccountChange a rule.
POST/api/v1/rules/:id/deleteaccountDelete a rule.
GET / POST/api/v1/violation-policyaccountAuto-revoke or notify on scope violations.
GET / POST/api/v1/approval-sla-actionaccountNotify or deny when a review’s SLA runs out.
GET / POST/api/v1/change-approval-policyaccountRequire a second person for risk-raising agent and rule changes.

Evidence & audit

Guide →

MethodPathAuthWhat it does
GET/api/v1/audit-logs?customer_id=…accountSealed audit records.
GET/api/v1/audit-integrity?customer_id=…accountRe-verify the chain now.
GET/api/v1/audit-checkpointsaccountPast signed checkpoints.
POST/api/v1/audit-checkpoints/verifyaccountCheck the log against a checkpoint you stored.
GET/api/v1/compliance-exports/evidence-bundlesessionOffline-verifiable evidence bundle.
GET/.well-known/jwks.jsonnonePublic keys for every token and signature Authentify issues.

Webhooks

Guide →

MethodPathAuthWhat it does
GET / POST/api/v1/webhook-endpointssessionList or register endpoints.
GET / DELETE/api/v1/webhook-endpoints/:idsessionOne endpoint and its deliveries, or disable it.
POST/api/v1/webhook-endpoints/:id/testsessionSend a signed ping.

Errors

StatusMeaning
200Success. For /v2/authorize, always read decision: a deny is still a 200.
400The request is malformed; the body says which field.
401Missing or invalid key or token.
403The credential is valid but not allowed here (for example an agent key on an account call).
404Not found in your account and environment.
429Too 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.