API Reference

RESTful API for digital identity analysis and browser fingerprinting. All endpoints return JSON responses with comprehensive telemetry data.

Base URL

Production
https://iphey.com/api/v1
Development
http://localhost:4310/api/v1

Endpoints

POST/api/v1/report

Generate a complete digital identity report including fingerprint analysis and IP reputation.

Request Body
{
  "fingerprint": {
    "userAgent": "string",
    "languages": "string[]",
    "timezone": "string",
    "screen": {
      "width": "number",
      "height": "number"
    },
    "webglVendor": "string",
    "canvasFingerprint": "string",
    "cookiesEnabled": "boolean"
  }
}
Response
{
  "verdict": "\"trustworthy\" | \"suspicious\" | \"unreliable\"",
  "score": "number0100",
  "ip": "string",
  "source": "string",
  "panels": "Panel[]",
  "enhanced": "EnhancedAnalysis"
}
GET/api/v1/health

Check API health status and build information.

Response
{
  "status": "\"ok\"",
  "timestamp": "string",
  "buildInfo": {
    "version": "string",
    "environment": "string"
  }
}

Response Fields

verdict
string

Overall assessment of digital identity: "trustworthy", "suspicious", or "unreliable"

score
number

Identity trust score from 0 (unreliable) to 100 (trustworthy)

panels
object

detailedAnalysis

enhanced
object

Advanced analysis with confidence scores, entropy metrics, and detailed signals

Authentication

No Authentication Required

The IPhey API is currently open and does not require authentication. All endpoints can be accessed without API keys or tokens.

Rate Limiting: The API implements rate limiting to prevent abuse. Please implement reasonable request throttling in your applications.

Example Usage

JavaScript / TypeScript

const response = await fetch('https://iphey.com/api/v1/report', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fingerprint: {
      userAgent: navigator.userAgent,
      languages: navigator.languages,
      timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
      screen: { width: screen.width, height: screen.height },
      cookiesEnabled: navigator.cookieEnabled,
    },
  }),
});

const data = await response.json();
console.log('Identity verdict:', data.verdict);
console.log('Trust score:', data.score);

Python

import requests

response = requests.post(
    'https://iphey.com/api/v1/report',
    json={
        'fingerprint': {
            'userAgent': 'Mozilla/5.0...',
            'languages': ['en-US', 'en'],
            'timezone': 'America/New_York',
            'cookiesEnabled': True,
        }
    }
)

data = response.json()
print(f"Verdict: {data['verdict']}")
print(f"Score: {data['score']}")