Clearedpay Xyz Authentication

generated: '2026-11-04'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://clearedpay.xyz/docs/guides/api-keys
sources:
- https://clearedpay.xyz/docs/guides/api-keys
- https://clearedpay.xyz/docs/api/authentication
- https://clearedpay.xyz/docs/mcp/overview
- https://clearedpay.xyz/docs/guides/share-invoices
description: Authentication methods for Cleared API
schemes:
- type: other
  name: HMAC
  evidence: 'Send all four headers on every authenticated request, including GET: Header Value x-cleared-key Full clr_pk_... key ID x-cleared-ts
    13-digit Unix-millisecond timestamp x-cleared-nonce Fresh unique nonce, for example a UUID Authorization CLEARED-HMAC followed by a standard
    base64 signature'
  location: header
  header: x-cleared-key, x-cleared-ts, x-cleared-nonce, Authorization
  how_to_obtain: Create an API key in the dashboard, which provides a public clr_pk_ key ID and a clr_sk_ secret. The secret is used to compute
    the HMAC signature.
- type: oauth2
  name: Hosted MCP OAuth
  evidence: Cleared supports authorization code with S256 PKCE and dynamic client registration. Sign in through the browser, select an organization
    and network, and explicitly approve permissions.
  location: header
  header: Authorization
  authorize_url: https://api.clearedpay.xyz/mcp
  scopes:
  - invoice:read
  - customer:read
  - dashboard:read
  - invoice:write
  - customer:write
  how_to_obtain: Use the hosted MCP client to perform the OAuth authorization code flow with PKCE; the client receives an opaque access token
    beginning clr_oat_.
- type: http-bearer
  name: Privy JWT
  evidence: 'Use Authorization: Bearer <Privy access token> for user routes. Obtain the token through the signed-in Privy session; Cleared API-key
    secrets cannot be substituted.'
  location: header
  header: Authorization
  how_to_obtain: Sign in to the Cleared web UI; the Privy session provides a JWT access token.
docs: https://clearedpay.xyz/docs/guides/api-keys