Facial Sign-In API Documentation

Ruby (Rails/Sinatra):

require 'rest-client'

# Extract browser info from incoming request
browser_ip = request.ip
browser_ua = request.user_agent

# Forward to Axiam API
response = RestClient.post(
  'https://axiam.io/api/v1/facial_sign_on/login/push_notification',
  { id: client_id }.to_json,
  {
    'Authorization' => "Bearer #{bearer_token}",
    'Content-Type' => 'application/json',
    'X-Forwarded-For' => browser_ip,
    'X-Browser-User-Agent' => browser_ua
  }
)

PHP (Laravel/Symfony):

$browserIp = $_SERVER['REMOTE_ADDR'];
$browserUa = $_SERVER['HTTP_USER_AGENT'];

$ch = curl_init('https://axiam.io/api/v1/facial_sign_on/login/push_notification');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['id' => $clientId]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $bearerToken,
    'Content-Type: application/json',
    'X-Forwarded-For: ' . $browserIp,
    'X-Browser-User-Agent: ' . $browserUa
]);
$response = curl_exec($ch);
curl_close($ch);

Node.js (Express):

const axios = require('axios');

// Extract from Express request
const browserIp = req.ip || req.connection.remoteAddress;
const browserUa = req.get('User-Agent');

// Forward to Axiam API
const response = await axios.post(
  'https://axiam.io/api/v1/facial_sign_on/login/push_notification',
  { id: clientId },
  {
    headers: {
      'Authorization': `Bearer ${bearerToken}`,
      'Content-Type': 'application/json',
      'X-Forwarded-For': browserIp,
      'X-Browser-User-Agent': browserUa
    }
  }
);

Python (Django/Flask):

import requests

# Extract from Flask/Django request
browser_ip = request.remote_addr
browser_ua = request.headers.get('User-Agent')

# Forward to Axiam API
response = requests.post(
    'https://axiam.io/api/v1/facial_sign_on/login/push_notification',
    json={'id': client_id},
    headers={
        'Authorization': f'Bearer {bearer_token}',
        'Content-Type': 'application/json',
        'X-Forwarded-For': browser_ip,
        'X-Browser-User-Agent': browser_ua
    }
)

1. Rate Limit Exceeded - Per IP (push_notification):

{
  "success": false,
  "code": 1020,
  "message": "Rate limit exceeded",
  "user_message": "Too many requests. Please try again in 45 seconds.",
  "data": {
    "rate_limit": {
      "limit": 10,
      "remaining": 0,
      "reset_after": 45
    }
  }
}

2. Rate Limit Exceeded - Per Client ID (push_notification):

{
  "success": false,
  "code": 1021,
  "message": "Rate limit exceeded for this account",
  "user_message": "Too many login attempts for this account. Please try again in 120 seconds.",
  "data": {
    "rate_limit": {
      "limit": 5,
      "remaining": 0,
      "reset_after": 120
    }
  }
}

3. Rate Limit Exceeded - Per IP (verify_token):

{
  "success": false,
  "code": 1022,
  "message": "Rate limit exceeded",
  "user_message": "Too many verification attempts. Please try again in 60 seconds.",
  "data": {
    "rate_limit": {
      "limit": 10,
      "remaining": 0,
      "reset_after": 60
    }
  }
}

4. Rate Limit Exceeded - Per Token (verify_token):

{
  "success": false,
  "code": 1023,
  "message": "Rate limit exceeded for this verification token",
  "user_message": "Too many attempts with this token. Please request a new one in 90 seconds.",
  "data": {
    "rate_limit": {
      "limit": 5,
      "remaining": 0,
      "reset_after": 90
    }
  }
}

5. Account Temporarily Locked:

{
  "success": false,
  "code": 1013,
  "message": "Account temporarily locked",
  "user_message": "Account locked due to multiple failed attempts. Please try again in 12 minutes."
}

6. Facial Service Permanently Disabled:

{
  "success": false,
  "code": 1041,
  "message": "Facial sign-on service permanently disabled",
  "user_message": "Facial sign-on has been permanently disabled for security reasons: Multiple security violations detected. Please use alternative login methods or contact support."
}