Skip to content
Last updated

Learn about the two authentication methods available for integrating with Cheqi.

Authentication Methods

Cheqi provides two authentication methods to suit different integration scenarios:

API Keys

Direct company access for merchants managing their own receipts.

Learn more about API Keys →

OAuth 2.0

Third-party access for POS systems and integrators.

Learn more about OAuth 2.0 →

Choosing the Right Method

Use API Keys When:

  • ✅ You are the merchant integrating your own POS system
  • ✅ You need to send receipts from your own systems
  • ✅ You manage multiple store locations or a franchise organization

Examples:

  • A restaurant owner integrating their own POS system to send digital receipts
  • A franchise organization like Domino's managing receipts for all franchise locations from a centralized system

Use OAuth 2.0 When:

  • ✅ You are a third-party building an integration for multiple merchants
  • ✅ You want merchants to authorize your application to start issuing receipts for them
  • ✅ You are building a POS system, accounting software, or marketplace integration

Example: A POS system provider offering Cheqi integration to all their customers.

Security Comparison

FeatureAPI KeysOAuth 2.0
Setup ComplexitySimpleModerate
Access ScopeFull company + child storesGranular scopes per company
Multi-Store SupportYes (parent + all child stores)Yes (per authorized company)
User AuthorizationNot requiredRequired per merchant
Token ExpirationNever (until revoked)Access tokens expire
Refresh TokensN/AYes
Best ForDirect merchant integration, franchisesThird-party platforms

Next Steps