# Web APIs

Cloud-based REST APIs for easy integration without SDK installation. Perfect for server-side applications and microservices.

# 🎯 Overview

The VerifEye Web APIs provide cloud-based biometric verification services accessible via simple REST endpoints. No SDK installation required - just make HTTP requests and get instant results.

# 📦 Available APIs

#
icon="shield-check" Face Liveness Cloud Web API
/web-api/face-liveness/

Detect live faces and prevent spoofing attacks via REST API.

#
icon="people" Face Match Cloud Web API
/web-api/face-match/

Compare and verify face similarity through simple HTTP requests.

#
icon="search" Face Search Cloud Web API
/web-api/face-search/

Search and identify faces in large databases.

#
icon="alert" DeepFake Verification Cloud Web API
/web-api/deepfake-verification/

Identify AI-generated or manipulated faces via API.

#
icon="person" Age/Gender Verification Cloud Web API
/web-api/age-gender-verification/

Estimate age and gender from facial images.


# 🚀 Key Features

  • No Installation - Just HTTP requests
  • Scalable - Auto-scaling cloud infrastructure
  • Global CDN - Low latency worldwide
  • RESTful - Standard HTTP methods
  • JSON - Simple request/response format
  • Secure - HTTPS with API key authentication

# 🌍 API Endpoints

Region Base URL
US East https://api-us-east.verifeye.com/v1
US West https://api-us-west.verifeye.com/v1
Europe https://api-eu.verifeye.com/v1
Asia Pacific https://api-ap.verifeye.com/v1

# 🔐 Authentication

All API requests require an API key in the header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

# 📥 Quick Start

# cURL Example

curl -X POST https://api-us-east.verifeye.com/v1/face/liveness \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "base64_encoded_image_data"
  }'

# JavaScript Example

const response = await fetch('https://api-us-east.verifeye.com/v1/face/liveness', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    image: base64Image
  })
});

const result = await response.json();
console.log(result);

# Python Example

import requests

url = "https://api-us-east.verifeye.com/v1/face/liveness"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "image": base64_image
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result)

# 📊 Rate Limits

Plan Requests/Second Requests/Month
Free 1 1,000
Starter 10 100,000
Professional 50 1,000,000
Enterprise Custom Unlimited

# 📚 Documentation

Each API includes comprehensive documentation:

  • Getting Started Guide - Authentication and setup
  • API Reference - Complete endpoint documentation
  • Code Examples - Sample requests in multiple languages
  • Release Notes - Version history and changes
  • Error Codes - Troubleshooting guide

# 🆘 Support


Last updated: 2025-01-13