Authentication

Secure your API requests using private and public API keys

Understanding API Keys

We provide two types of API keys for different purposes:

API Key Capabilities

Your API key provides access to:

• Face verification between photos
• Spoof detection
• Photo optimization
• Camera integration

Keep your API key secure and use environment variables when possible.

Getting Your API Keys

To get started with our API:

1 Create an account or sign in to your existing account
2 Navigate to the Dashboard
3 Click on "Generate New API Key"
4 Give your API key a name (e.g., "Production", "Testing")
5 Copy and securely store your API key

Using API Keys

Include the appropriate API key in the Authorization header based on the endpoint:

Verify faces using your API key:

curl -X POST https://api.example.com/api/v2/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "reference=@path/to/reference.jpg" \
  -F "selfie=@path/to/selfie.jpg"

Check for spoofing attempts:

curl -X POST https://api.example.com/api/v2/spoof \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "photo=@path/to/photo.jpg"

Use the camera integration:

// Initialize camera with callback
const camera = new VerifyCamera((photoData) => {
    if (photoData) {
        console.log('Photo captured successfully');
    }
});

// Start camera interface
await camera.start();

API Key Security

Security Best Practices

Never share your API key or commit it to version control
Use environment variables to store API keys in your applications
Generate separate API keys for development and production
Rotate API keys periodically for enhanced security
Revoke compromised API keys immediately from your dashboard

Key Management

Manage your API keys through the Dashboard:

View all active API keys
Generate new API keys
Revoke existing API keys
Monitor API key usage and rate limits