Developer Portal
Dashboard Overview
What is the Developer Portal?
The Opacity Developer Portal is where you manage everything you need to build apps with Opacity. Here you can generate API keys, browse available platforms, create templates for user flows, and configure your integrations.
API Key Management
What are API Keys?
API keys are like passwords that let your app talk to Opacity. You'll need one to build with Opacity.
How it Works
- Get your permanent API key from the API Keys section
- Generate temporary tokens from your permanent key (recommended for security)
- Use the temporary token in your app instead of exposing your permanent key
Think of it like this: your permanent key is your house key (keep it safe at home), and temporary tokens are guest passes you give out (they expire automatically).
Why use temporary tokens?
- They expire automatically so there's less risk
- Your permanent key stays safe on your server
- If a token gets stolen, it's only valid for a short time
Full API Key Documentation β
Platforms and Resources
What are Platforms?
Platforms are the different websites and services you can verify data from, like Instagram, GitHub, or your bank.
How to View Platforms
- Go to Platforms in your dashboard
- Browse available platforms (Instagram, GitHub, etc.)
- Click on any platform to see what data you can verify
- Example: Instagram lets you verify your profile, comments, and posts
Preview Platforms: Some platforms are still being built and will show up as "Preview" - they'll be ready soon!
Coming Soon: You'll be able to choose exactly which data points your app can access using toggle switches.
Full Platforms Documentation β
Multipass: Creating Templates
What is Multipass?
Multipass is Opacity's user-friendly verification flow. Instead of building the entire verification UI yourself, you create a template and send users through a hosted Opacity page that handles everything - authentication, data selection, and proof generation.
What is a Template?
A template defines the verification flow for your users. It specifies:
- Which platform they'll connect to (GitHub, Instagram, bank, etc.)
- What data they'll verify (profile, balance, posts, etc.)
- Where the results go (your webhook endpoint)
- Where users return after completing verification (your app or website)
Why Use Templates?
- No UI to build: Opacity handles the entire verification interface
- Secure by default: Users authenticate directly with the platform
- Reusable: Create once, use for all your users
- Customizable: Set your own webhooks and redirect URLs
Setting Up a Template
- Navigate to Platforms in the Developer Portal
- Select the platform you want users to verify from
- Click "Template" to create your flow configuration
- Configure your endpoints:
- Webhook URL: Your server endpoint that receives the verified data
- Redirect URI: Where to send users after verification completes
- Save your Template ID for creating user links
How It Works in Practice
Once you have a template ID, you generate a unique link for each user. When they click it:
- They're taken to Opacity's verification page
- They authenticate with the platform (e.g., log into GitHub)
- Opacity generates the proof and sends it to your webhook
- The user is redirected back to your app
You never see their passwords or sensitive data - just the verified proof!
Full Template Documentation β
SDK Integration
React Native (Recommended for Cross-Platform)
- Build once for both iOS and Android
- Uses JavaScript/TypeScript
- Fastest way to get native apps on both platforms
- View React Native Guide β
Android (Native)
- Pure Android development with Kotlin
- Best performance for Android-only apps
- Full access to Android platform features
- View Android Guide β
Flutter
- Cross-platform with Dart language
- Great if you're already using Flutter
- Single codebase for iOS and Android
- View Flutter Guide β
iOS (Native)
- Pure iOS development with Swift
- Best performance for iOS-only apps
- Full access to iOS platform features
- View iOS Guide β
The SDK handles all the complex cryptography, authentication, and proof generation - you just make simple function calls.
This is an introductory guide. Click the links above for detailed technical documentation.