FRS API, running in five minutes

Step 1 · Create your account (1 min)

1. Go to the developer portal
2. Click "Register"
3. Fill in:
   • Your email
   • A username of your choice
   • A password
4. Click "Sign Up"

You'll receive:

• API Key: f1377d82a0e43f4a... (32 characters)
• API Secret: f0a48b922f4550aa... (64 characters)

Important: save these credentials somewhere safe!

Step 2 · Log in (30 sec)

1. Enter your email and password
2. Click "Login"
3. You'll see your dashboard

Step 3 · Add your first face (2 min)

Method A: using the web interface

1. Click the "Add Face" button on the dashboard
2. Upload a photo (JPG or PNG)
3. Enter the details:
   • Name: John Doe
   • User ID: JOHN001
   • Active: tick this box
4. Click "Save Face"

Done — your first face is added.

Method B: using the API

# Replace YOUR_API_KEY and YOUR_API_SECRET
# with your actual credentials.

curl -X POST \
  "https://solutions.virtisha.com" \
  -H "api_key: YOUR_API_KEY" \
  -H "api_secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "image_b64": "BASE64_ENCODED_IMAGE_HERE",
  "userId": "JOHN001",
  "user_name": "John Doe",
  "active": 1
}'

Step 4 · Search for a face (1 min)

Method A: using the web interface

1. Click "Search" in the menu
2. Upload an image containing a face
3. Click "Search"
4. See the results with similarity scores

Method B: using the API

curl -X POST \
  "https://solutions.virtisha.com" \
  -H "api_key: YOUR_API_KEY" \
  -H "api_secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "image_b64": "BASE64_ENCODED_IMAGE_HERE"
}'

Response:

{
  "status": true,
  "message": "Face recognized",
  "responsePacket": {
    "name": "John Doe",
    "userId": "JOHN001",
    "similarity": 0.95
  }
}

Step 5 · Monitor your usage (30 sec)

Check via the API

# 1. Get your token by logging in:
curl -X POST \
  "https://solutions.virtisha.com" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "your@email.com",
  "password": "your_password"
}'

# 2. Use the token to check usage:
BASE="https://solutions.virtisha.com"
curl -X GET \
  "$BASE/auth/rate-limit-status/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response:

{
  "subscription_plan": "Free",
  "total_requests": 3,
  "limits": {
    "hourly": {
      "used": 3,
      "limit": 200,
      "remaining": 197
    },
    "daily": {
      "used": 3,
      "limit": 200,
      "remaining": 197
    },
    "monthly": {
      "used": 3,
      "limit": 2000,
      "remaining": 1997
    }
  }
}

That's it — you're now ready to use the face recognition system.

Your free plan includes

Common first-time questions

How do I convert an image to Base64?

Python:

import base64

with open("photo.jpg", "rb") as f:
    raw = f.read()

image_b64 = base64.b64encode(raw)
image_b64 = image_b64.decode("utf-8")

JavaScript (Node.js):

const fs = require('fs');

const image_b64 = fs.readFileSync(
  'photo.jpg',
  'base64'
);

Tip: encode images in your own code (as above) — almost every language has a built-in Base64 function. Avoid uploading face photos to third-party converter sites.

What makes a good face photo?

Good photos:

• Clear and well-lit
• Face looking forward
• No sunglasses
• High resolution
• A single person in frame

Avoid:

• Blurry or dark images
• Extreme angles
• Sunglasses or masks
• Multiple faces
• Very small faces

What if I hit my rate limit?

You'll see an error like this:

{
  "detail": "Hourly API limit exceeded."
}

The full message also tells you your limit (e.g. 200/hour) and when it resets (e.g. "Resets in 45 minutes").

Solutions:

• Wait for the limit to reset
• Upgrade your plan
• Optimise your code to make fewer API calls

How secure are my API credentials?

Security tips:

• Never share your API key or secret
• Don't commit them to GitHub
• Store them in environment variables
• Rotate them if they're ever compromised

Need help?

• Email: enquiry@virtisha.com
• Chat: available on the dashboard
• Full guide: read the User Guide

Quick reference card

Save this for later:

YOUR CREDENTIALS
================
API Key:    ____________________
API Secret: ____________________
Token:      ____________________

IMPORTANT URLS
==============
Dashboard:
https://solutions.virtisha.com
API Docs:
https://solutions.virtisha.com
Login:
https://solutions.virtisha.com

RATE LIMITS (FREE PLAN)
=======================
Hourly:  200 requests
Daily:   200 requests
Monthly: 2,000 requests

SUPPORT
=======
Email: enquiry@virtisha.com
Chat:  available on the dashboard

Next steps

Welcome to face recognition — you're now ready to build applications on top of the platform. From here:

• Add more faces to build up your database
• Explore the dashboard to see every feature
• Read the User Guide for advanced features and the full API reference
• Browse the FAQ Docs for answers to common questions
• Sign in to the developer portal to manage your keys and integrate the API into your applications