Powered by

# Getting Started with VerifEye

Welcome! This guide will help you get started with VerifEye's biometric verification solutions.

# 🎯 Choose Your Platform

VerifEye offers multiple integration options to suit your needs:

# 1. Cross-Platform C++ SDK

Best for native applications requiring maximum performance.

C++ SDK Getting Started
../cpp-sdk/getting-started/

Use Cases:

  • Desktop applications (Windows, macOS, Linux)
  • Mobile apps (iOS, Android)
  • Embedded systems
  • High-performance requirements

# 2. Web APIs

Best for server-side applications and microservices.

Web API Getting Started
../web-api/getting-started/

Use Cases:

  • Backend services
  • Microservices architecture
  • Server-side verification
  • No client-side SDK needed

# 3. JavaScript SDK

Best for web applications with client-side processing.

JavaScript SDK Getting Started
../js-sdk/getting-started/

Use Cases:

  • Single-page applications (React, Vue, Angular)
  • Progressive web apps
  • Browser-based verification
  • Real-time webcam processing

# 4. JavaScript Redirect SDK

Best for applications needing a hosted verification flow.

JS Redirect SDK Getting Started
../js-redirect-sdk/getting-started/

Use Cases:

  • Quick integration
  • No UI development needed
  • Hosted verification pages
  • OAuth-like flow

# 5. Mobile SDK

Best for native mobile applications.

Mobile SDK Getting Started
../mobile-sdk/getting-started/

Use Cases:

  • Native iOS apps
  • Native Android apps
  • React Native apps
  • Flutter apps

# 📋 Prerequisites

Before you begin, you'll need:

  1. VerifEye Account

  2. API Key

    • Log in to your dashboard
    • Navigate to Settings → API Keys
    • Generate a new API key

  3. Development Environment

    • Choose your platform-specific requirements
    • Install necessary tools and dependencies

# 🚀 Quick Start Steps

# Step 1: Get Your API Key 

# Your API key will look like this:
ve_live_1234567890abcdef1234567890abcdef

# Step 2: Choose Your Integration

Select the platform that best fits your needs from the options above.

# Step 3: Install the SDK/Library

Follow the installation instructions for your chosen platform.

# Step 4: Initialize and Test

Run your first verification to ensure everything is working correctly.

# 🎓 Learning Path

# Beginner

  1. Read the platform-specific Getting Started guide
  2. Run the "Hello World" example
  3. Understand authentication and API keys
  4. Test with sample images

# Intermediate

  1. Explore API Reference documentation
  2. Implement error handling
  3. Add liveness detection
  4. Optimize for performance

# Advanced

  1. Implement custom workflows
  2. Set up webhooks
  3. Configure advanced security
  4. Scale for production

# 📚 Next Steps

After completing the basic setup:

  • Explore Features: Learn about Face Liveness, Face Match, DeepFake Detection, and more
  • Review Best Practices: Security, performance, and UX guidelines
  • Join Community: Connect with other developers
  • Read API Reference: Detailed documentation for all endpoints

# 🆘 Need Help?

Have questions or need assistance? We're here to help!

Contact Us
../contact/

# 🔗 Useful Links

Last updated: 2025-01-13