title: Quick Start Guide description: This section provides an overview of the Quick Start Guide for integrating Hive Forensics AI's APIs.

Overview

Welcome to the Quick Start Guide for Hive Forensics AI's suite of APIs. This guide provides the essential steps to get started with our powerful tools for fraud detection and identity verification. You will find step-by-step instructions, usage examples, and code snippets to help you integrate these APIs efficiently into your applications.

Content

  • Fraud Buster API: Detect and prevent online transaction fraud.
  • Spektrum API: Verify identities using advanced image analysis.

Fraud Buster API

The Fraud Buster API is designed to help businesses detect and prevent fraudulent transactions. It analyzes various transaction attributes and returns a risk score, helping you identify suspicious activities.

Key Features:

  • Analyze online transaction data
  • Return fraud risk scores
  • Customizable for your platform

Endpoint

POST /api/transaction

Headers:

{
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY"
}

Request Payload Example:

{
  "email": "sam@aol.com",
  "product": "Laptop",
  "amount": 1200,
  "location": "Miami",
  "time": "2024-03-04T10:30:00Z",
  "customerProfile": "Tech Enthusiast",
  "onlinePurchase": true,
  "paymentMethod": "MasterCard",
  "shippingAddress": "PO BOX 09900 Miami Floirda 33157",
  "billingAddress": "PO BOX 21225 San Diego California 90211",
  "customerEmail": "janedoe@gmail.com",
  "customerName": "Jane Doe",
  "isVPN": false,
  "clientBrowser": "Chrome",
  "deviceType": "Desktop",
  "ipAddress": "192.168.1.1",
  "deviceFingerprint": "abcd1234efgh5678",
  "transactionFrequency": 2,
  "accountAge": 365,
  "emailDomain": "gmail.com",
  "addressMismatch": true,
  "twoFactorAuth": false,
  "referralSource": "Google Search",
  "proxyOrVPN": false,
  "orderQuantity": 1
}

Code Example in Python

import requests

url = 'http://localhost:3000/api/transaction'
headers = {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY'
}
transaction_data = {
    "email": "sam@aol.com",
    "product": "Laptop",
    "amount": 1200,
    "location": "Miami",
    "time": "2024-03-04T10:30:00Z",
    "customerProfile": "Tech Enthusiast",
    "onlinePurchase": True,
    "paymentMethod": "MasterCard",
    "shippingAddress": "PO BOX 09900 Miami Floirda 33157",
    "billingAddress": "PO BOX 21225 San Diego California 90211",
    "customerEmail": "janedoe@gmail.com",
    "customerName": "Jane Doe",
    "isVPN": False,
    "clientBrowser": "Chrome",
    "deviceType": "Desktop",
    "ipAddress": "192.168.1.1",
    "deviceFingerprint": "abcd1234efgh5678",
    "transactionFrequency": 2,
    "accountAge": 365,
    "emailDomain": "gmail.com",
    "addressMismatch": True,
    "twoFactorAuth": False,
    "referralSource": "Google Search",
    "proxyOrVPN": False,
    "orderQuantity": 1
}

response = requests.post(url, headers=headers, json=transaction_data)
print("Response:", response.json())

Spektrum API

The Spektrum API is a powerful identity verification tool that uses image analysis to verify individuals' identities. It is designed to integrate with platforms where accurate identity verification is crucial.

Key Features:

  • Verify identity using image uploads
  • Return verification results
  • Secure and accurate verification

Endpoint

POST /assess-id

Headers:

{
  "Content-Type": "multipart/form-data",
  "x-api-key": "YOUR_API_KEY"
}

Request Payload Example:

--form 'image=@"/path/to/your/image.png"'

Code Example in Python

import requests

url = 'http://localhost:3000/assess-id'
headers = {
    'x-api-key': 'YOUR_API_KEY'
}
files = {
    'image': open('/path/to/your/image.png', 'rb')
}

response = requests.post(url, headers=headers, files=files)
print("Response:", response.json())

FAQ

For more detailed information, please visit our FAQ section.


### Key Points:
- **Fraud Buster API Section**: Contains API endpoint, request payload example, headers, and Python code example for fraud detection.
- **Spektrum API Section**: Contains API endpoint, request payload example, headers, and Python code example for identity verification.
- **Overview and FAQ**: Provides a high-level introduction to both APIs and directs users to the FAQ section for more information.