FxFaximus Developers
Production APIPortal

API Authentication

Learn how bearer tokens, API key scopes, and customer roles control access to the Faximus API.

StartAuthenticationDocumentsFax JobsInboxEmail FaxWebhooksErrorsOpenAPI

Reference

Authentication

GET/v1/api-keysList API keysRead account-scoped API keys visible to the signed-in customer admin.Customer session

Read account-scoped API keys visible to the signed-in customer admin.

Required scope
Customer session
Authentication
Customer owner/admin session; API keys cannot manage credentials
Base URL
https://api.faximus.io
OpenAPI operation
listApiKeys
Response example
{
  "items": [
    {
      "apiKeyId": "99999999-9999-4999-8999-999999999999",
      "tenantId": "11111111-1111-4111-8111-111111111111",
      "name": "claims-worker",
      "keyPrefix": "D-APalYY",
      "scopeSet": [
        "fax:send",
        "fax:read",
        "webhook:manage"
      ],
      "environment": "production",
      "status": "active",
      "createdAt": "2026-06-20T14:12:48.000Z",
      "updatedAt": "2026-06-20T14:12:48.000Z"
    }
  ]
}
POST/v1/api-keysCreate an API keyIssue a scoped server key. The raw secret is returned once in the create response.Customer session

Issue a scoped server key. The raw secret is returned once in the create response.

Required scope
Customer session
Authentication
Customer owner/admin session; API keys cannot manage credentials
Base URL
https://api.faximus.io
OpenAPI operation
createApiKey
Response example
{
  "apiKey": {
    "apiKeyId": "99999999-9999-4999-8999-999999999999",
    "tenantId": "11111111-1111-4111-8111-111111111111",
    "name": "claims-worker",
    "keyPrefix": "D-APalYY",
    "scopeSet": [
      "fax:send",
      "fax:read",
      "webhook:manage"
    ],
    "environment": "production",
    "status": "active",
    "createdAt": "2026-06-20T14:12:48.000Z",
    "updatedAt": "2026-06-20T14:12:48.000Z"
  },
  "plaintextKey": "fxk_production_D-APalYY_redactedExampleOnly"
}
POST/v1/api-keys/{apiKeyId}/revokeRevoke an API keyImmediately disables a server integration key without deleting audit history.Customer session

Immediately disables a server integration key without deleting audit history.

Required scope
Customer session
Authentication
Customer owner/admin session; API keys cannot manage credentials
Base URL
https://api.faximus.io
OpenAPI operation
revokeApiKey
Response example
{
  "apiKey": {
    "apiKeyId": "99999999-9999-4999-8999-999999999999",
    "tenantId": "11111111-1111-4111-8111-111111111111",
    "name": "claims-worker",
    "keyPrefix": "D-APalYY",
    "scopeSet": [
      "fax:send",
      "fax:read",
      "webhook:manage"
    ],
    "environment": "production",
    "status": "revoked",
    "createdAt": "2026-06-20T14:12:48.000Z",
    "updatedAt": "2026-06-20T14:12:48.000Z"
  }
}
PATCH/v1/account/session-policyUpdate portal session policyCustomer owners and admins can set the account's customer portal session TTL. Members can read the current policy from account profile but cannot change it.Customer owner/admin session

Customer owners and admins can set the account's customer portal session TTL. Members can read the current policy from account profile but cannot change it.

Required scope
Customer owner/admin session
Authentication
Customer owner/admin session; API keys cannot manage credentials
Base URL
https://api.faximus.io
OpenAPI operation
updateAccountSessionPolicy
Response example
{
  "event": "customer_account_session_policy_updated",
  "accountId": "22222222-2222-4222-8222-222222222222",
  "tenantId": "11111111-1111-4111-8111-111111111111",
  "sessionPolicy": {
    "ttlSeconds": 14400,
    "minTtlSeconds": 900,
    "maxTtlSeconds": 86400,
    "effectiveExpiresAt": "2026-06-20T18:12:48.000Z"
  }
}