Skip to content

API Reference

The Flowsta Auth API provides OAuth 2.0 + PKCE authentication, Vault sign-in, and Sign It signing/verification endpoints.

Base URL

https://auth-api.flowsta.com

OAuth Endpoints

The OAuth 2.0 + PKCE surface - /oauth/authorize, /oauth/token, /oauth/userinfo, and /oauth/revoke - covers the full "Sign in with Flowsta" flow. No client secret is required: PKCE (code_challenge / code_verifier) secures the exchange, so your Client ID is all you need.

Full request/response documentation, scopes, error codes, and rate limits live in the canonical reference:

View the OAuth API Reference →

Token lifetimes at a glance:

Token TypeLifetime
Authorization Code10 minutes
Access Token24 hours
Refresh Token30 days

Vault Sign-In Endpoints

Device-key sign-in from Flowsta Vault uses a challenge-signature exchange: POST /auth/vault/challenge issues a one-time challenge, and POST /auth/vault/token verifies the device's signature and returns a JWT plus the flowsta_session SSO cookie. Full documentation lives in the OAuth API Reference.

SDK Usage

We recommend using the official SDK instead of calling the API directly:

typescript
import { FlowstaAuth } from '@flowsta/auth';

const auth = new FlowstaAuth({
  clientId: 'flowsta_app_abc123',
  redirectUri: 'https://yourapp.com/callback'
});

// Redirect to Flowsta login
auth.login();

// Handle callback (PKCE handled automatically)
const user = await auth.handleCallback();

View SDK Documentation →

Vault IPC Endpoints

Flowsta Vault provides a local IPC API for desktop apps:

  • Agent linking (identity attestations)
  • Desktop app authentication
  • App data backups
  • Data signing

View IPC Endpoints →

Sign It Endpoints

Document signing and verification API. Verification endpoints are public - no authentication required.

EndpointMethodAuthDescription
/api/v1/sign-it/verifyGETPublicLook up signatures by file hash
/api/v1/sign-it/verify-filePOSTPublicUpload file for fuzzy perceptual matching
/api/v1/sign-it/verify-fuzzyPOSTPublicFuzzy lookup with pre-computed bands
/api/v1/sign-it/signPOSTJWT / OAuth (sign scope)Sign a file hash
/api/v1/sign-it/sign-batchPOSTJWT / OAuth (sign scope)Sign multiple file hashes
/api/v1/sign-it/my-signaturesGETJWT / OAuth (verify scope)Get user's signatures + linked agents
/api/v1/sign-it/revokePOSTJWT / OAuth (sign scope)Revoke a signature
/api/v1/sign-it/contactPOSTPublicBlind email relay to signer

View full Sign It API Reference →

Complete Auth Documentation

For detailed documentation including PKCE implementation, framework-specific examples, and security best practices:

View Auth Documentation →

Support

Need help with the API?

Documentation licensed under CC BY-SA 4.0.