# Security API

The VerifEye Security API provides authentication and token management services for secure access to the VerifEye ecosystem.

# Overview

The Security API enables you to:

  • Generate JWT tokens for client-side authentication
  • Retrieve server UTC time for synchronization
  • Validate API credentials
  • Monitor API health status

# Base URLs

Region Base URL
EU https://security-api-eu.realeyes.ai/v1/
US https://security-api-us.realeyes.ai/v1/

# API Endpoints

# Get JWT Token

Generate a JWT token for authentication.

Endpoint: GET /v1/token/get

Authentication: API Key only (Bearer tokens are not allowed for this endpoint)

Query Parameters:

Parameter Type Required Default Description
expirationInSeconds integer No 900 Token expiration time in seconds. Min: 60, Max: 3600

Response:

{
  "expirationUtcTime": "2026-01-26T14:30:00.000Z",
  "token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9..."
}

Example Request:

curl -X GET "https://security-api-eu.realeyes.ai/v1/token/get?expirationInSeconds=3600" \
  -H "Authorization: ApiKey QUJDMTIzOnlvdXItYXBpLWtleS1oZXJl"

Response Codes:

  • 200 - Success
  • 401 - Unauthorized (invalid or missing API key)

# Get Server UTC Time

Retrieve the current server time in UTC for time synchronization.

Endpoint: GET /v1/datetime/utc-now

Authentication: API Key or Bearer Token

Response:

{
  "utcNow": "2026-01-26T13:45:30.1234567Z"
}

Example Request:

curl -X GET "https://security-api-eu.realeyes.ai/v1/datetime/utc-now" \
  -H "Authorization: ApiKey QUJDMTIzOnlvdXItYXBpLWtleS1oZXJl"

Response Codes:

  • 200 - Success
  • 401 - Unauthorized
  • 403 - Forbidden (valid auth but account not found)

# Health Check

Check the API health status.

Endpoint: GET /v1/healthz

Authentication: None required

Response:

2026-01-26T13:45:30.1234567Z

Example Request:

curl -X GET "https://security-api-eu.realeyes.ai/v1/healthz"

Response Codes:

  • 200 - API is healthy

# Common Response Codes

Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Missing or invalid authentication
403 Forbidden - Valid authentication but account not found or insufficient permissions
500 Internal Server Error

# Swagger Documentation

Interactive API documentation is available via Swagger UI:


Last updated: 2026-01-26