Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Getting Started
  • Choosing the Right API Version
  • Getting Started
  • Architecture
  • Quick Start
  • Authentication
  • Roles and API Access
  • API Categories
  • API Endpoints Reference
  • Making Your First API Call
  • Working with Encrypted Tokens
  • Code Examples
  • Error Handling
  • Best Practices
  • Troubleshooting
  • Support
  1. Getting Started

Authentication

Token-Based Authentication#

Convirza uses encrypted Bearer token authentication with server-side session storage.

How It Works#

1.
Obtain Tokens:
Send your credentials to POST /oauth/token
Receive an encrypted access_token and refresh_token
Store both tokens securely in your application
2.
Make API Requests:
Include the access token in every request: Authorization: Bearer <access_token>
The API validates your token and authorizes the request
If valid, your request proceeds; if invalid, you receive a 401 error
3.
Token Characteristics:
Access Token: Valid for 7 days
Refresh Token: Valid for 6 months
Format: Encrypted opaque strings (use as-is, do not decode)
Revocation: Immediate via POST /oauth/revoke-token

Authorization Header Format#

Authorization: Bearer <encrypted_access_token>

Token Lifecycle#

Login → Access Token (7d) + Refresh Token (6mo)
  ↓
Use Access Token for API calls
  ↓
Access Token Expires → Use Refresh Token → New Token Pair
  ↓
Refresh Token Expires → Re-login Required
Modified at 2026-04-13 06:15:41
Previous
Quick Start
Next
Roles and API Access
Built with