Skip to main content

Getting Started with ConsentKeys

Welcome to ConsentKeys! This documentation will help you integrate privacy-focused authentication into your application in minutes.

What is ConsentKeys?​

ConsentKeys is an OpenID Connect (OIDC) identity provider that focuses on:

  • Passwordless Authentication: Magic link-based login (no passwords to manage)
  • Privacy-First: Pseudonymous user profiles and minimal data collection
  • Developer-Friendly: Standard OAuth 2.0/OIDC protocols with comprehensive SDKs
  • Multi-Account Support: Users can manage multiple identities seamlessly

Quick Start​

Choose your platform to get started:

⚛️ React

Single-page applications with React

▲ Next.js

Full-stack React applications

🐍 Python

Flask and Django applications

Core Features​

No passwords to remember, manage, or leak. Users receive a secure link via email.

→ Learn about magic links

Standard OAuth 2.0 / OIDC​

Built on industry standards for maximum compatibility with existing tools and libraries.

→ Understand the auth flow

Flexible Scopes​

Request only the data you need with granular scope control.

→ Explore scopes and claims

Complete API​

Full REST API for client management, monitoring, and user operations.

→ Browse API reference

How It Works​

  1. Your app redirects users to ConsentKeys (https://api.consentkeys.com/auth)
  2. Users authenticate with magic links (no passwords!)
  3. ConsentKeys sends an authorization code back to your app
  4. Your backend exchanges the code for access tokens
  5. You're done - users are authenticated!
Getting Started

Visit the Developer Portal to:

  • Register your application
  • Get your Client ID and Secret
  • Configure your redirect URI (where users return to your app after authentication)

Prerequisites​

Before integrating ConsentKeys, you'll need:

  1. Client ID and Secret: Register your application in the Developer Portal
  2. Redirect URI: Configure where users return after authentication (e.g., https://yourapp.com/callback)
  3. Development environment: Node.js, Python, or your preferred stack

Documentation Structure​

This documentation is organized into three tiers:

📚 Integrations (Start Here)​

Copy-paste code examples to integrate ConsentKeys quickly:

💡 Concepts (Understand the Flow)​

Deep dives into how ConsentKeys works:

🔧 API Reference (Technical Details)​

Complete OpenAPI specification with interactive playground:

Support​

Need help? We're here for you:

Next Steps​

Ready to integrate? Pick your platform:

Or learn the concepts: