Face Verification API Documentation

Secure face identification and verification platform that provides facial recognition capabilities through REST endpoints or our JavaScript SDK.

Quick Start

Get up and running with our Face Verification API in minutes:

  1. 1 Sign up for an API key
  2. 2 Review the authentication guide
  3. 3 Explore the API reference
  4. 4 Test your integration using our live demo

Integration Options

REST API

Direct API access with your private API key. Full control over the implementation and customization.

JavaScript SDK

Quick integration with our JavaScript functions for camera verification. We handle the UI and API calls for you.

Core Features

Face ID Creation

Create and manage unique Face IDs for your users with our private API endpoints.

Face Verification

Verify faces against stored Face IDs with high accuracy using our public API endpoint.

Camera Integration

Easy-to-use JavaScript SDK for camera capture and verification on both desktop and mobile.

Implementation Overview

Our API provides two types of endpoints, secured with different API keys:

POST /api/v2/face_id - Create Face ID (Private API Key)
DELETE /api/v2/face_id - Delete Face ID (Private API Key)
POST /api/v2/verify - Verify Face (Public API Key)

All endpoints are secured with enterprise-grade security and maintain strict data privacy standards.

JavaScript SDK

Quick integration with our JavaScript SDK:

// Initialize with your public API key
const faceVerify = new FaceVerify('YOUR_PUBLIC_API_KEY');

// Start camera
await faceVerify.initCamera('#camera-container');

// Verify face
const result = await faceVerify.verify('face_id');
if (result.match) {
    console.log('Verification successful!');
}

Data Privacy

We prioritize security and privacy:

  • No face photos stored
  • No face embeddings stored
  • Only store AWS Face IDs and match results