Hive Forensics AI - FAQ Section

Frequently Asked Questions (FAQ)

Overview

Welcome to the FAQ section! Here, you'll find answers to the most commonly asked questions about Hive Forensics AI’s products and services, including the Fraud Buster API and Spektrum API.

This section is designed to help you:

  • Troubleshoot issues quickly.
  • Understand key features and functionalities.
  • Optimize API integration for better performance.

Content

  1. Introduction - Overview of Hive Forensics APIs and their functionalities.
  2. API Key Management - How to obtain, use, and secure your API key.
  3. Integration Guidance - Best practices for integrating our APIs.
  4. Troubleshooting - Solutions to common problems and errors.
  5. General FAQ - Answers to frequently asked questions.

Getting Started

1. Introduction

The FAQ section covers the essential concepts and steps to help you get started with Hive Forensics AI APIs. Whether you're integrating fraud detection or identity verification, this guide ensures a smooth experience.

2. API Key Management

How do I obtain an API key?

You can obtain an API key by registering on the Hive Forensics AI portal. Once registered:

  1. Navigate to the API Keys section in your dashboard.
  2. Generate a new key.
  3. Copy the key securely, as it’s required for authenticating requests.

How should I secure my API key?

  • Never expose API keys in client-side code or version control repositories.
  • Use environment variables (.env) or secure vaults like AWS Secrets Manager.
  • Implement access controls to protect your keys from unauthorized usage.
  • Regularly rotate keys to minimize security risks.

3. Integration Guidance

What are the best practices for integrating the Fraud Buster API?

  • Set up dependencies: Install required tools such as Node.js, React, Laravel, or Gatsby to match your development environment.
  • Secure API Requests: Always use HTTPS to encrypt sensitive data during API calls.
  • Error Handling: Handle status codes (e.g., 401 Unauthorized, 500 Internal Server Error) and implement retry logic for network failures.
  • Optimize Payloads: Send only the required fields to reduce request size and improve performance.

How do I upload images for identity verification using the Spektrum API?

  • Format: Ensure the image is in a supported format (e.g., JPEG, PNG).
  • Quality: Use high-resolution, well-lit images for better accuracy.
  • Multipart/Form-Data: Send the image file as multipart/form-data along with authentication headers.

Example in Python:

import requests

url = 'https://api.hiveforensics.com/assess-id'
headers = {
    'x-api-key': 'YOUR_API_KEY'
}
files = {
    'image': open('path-to-image.jpg', 'rb')
}

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

4. Troubleshooting

I’m receiving a 401 Unauthorized error. What should I do?

  • Verify your API key: Ensure the correct key is being sent in the x-api-key header.
  • Check environment variables: Confirm that keys are loaded properly in .env files.
  • Regenerate the key: Try creating a new API key from the Hive Forensics AI portal if the issue persists.

The API response times are slow. How can I improve performance?

  1. Optimize payloads: Send only the required data fields.
  2. Network optimization: Ensure your internet connection is stable and has low latency.
  3. Batch processing: Group multiple transactions into a single request if supported.
  4. Contact Support: If performance issues persist, reach out to Hive Forensics AI support for assistance.

What should I do if I hit the rate limit (429 Too Many Requests)?

  • Rate Limits: Our APIs enforce limits to prevent abuse. If you hit a limit, you’ll receive a 429 status.
  • Retry Strategy: Implement exponential backoff to retry requests after delays:

Example in JavaScript:

const fetchWithRetry = async (url, options, retries = 3, delay = 1000) => {
  for (let i = 0; i < retries; i++) {
    const response = await fetch(url, options);
    if (response.status !== 429) return response;
    await new Promise(resolve => setTimeout(resolve, delay * (i + 1)));
  }
  throw new Error('Rate limit exceeded');
};

5. General FAQ

Can I use Hive Forensics AI APIs for real-time fraud detection?

Yes! Our APIs are built for real-time processing and can handle transaction checks within milliseconds. Just ensure your application is optimized for asynchronous requests.

What types of images are supported by the Spektrum API?

The Spektrum API supports the following formats:

  • JPEG
  • PNG
  • WEBP

Make sure the image is clear, well-lit, and within the size limits specified in our documentation.

How do I handle errors from the Fraud Buster API?

Errors can occur due to:

  1. Invalid Payload (400 Bad Request): Ensure all required fields are included in the payload.
  2. Unauthorized Access (401 Unauthorized): Verify your API key and headers.
  3. Server Errors (500 Internal Server Error): Retry requests or contact support if issues persist.

Use the isLoading and error states in React hooks to dynamically manage UI feedback.

What happens if my API key is compromised?

  1. Revoke the compromised key immediately from the Hive Forensics AI portal.
  2. Generate a new key and update your application.
  3. Audit logs to identify unauthorized usage and take corrective measures.

What level of customization is available for fraud detection?

You can customize fraud detection strictness levels by setting parameters like:

  • Strictness: Values range from 50 (very strict) to 150 (relaxed).
  • Transaction Thresholds: Configure triggers based on transaction frequency, amounts, or geographic patterns.

Need More Help?

If you need additional assistance:

  • Contact Support: Reach out to our Hive Forensics AI support team.
  • Documentation: Refer to the detailed guides for frameworks like React, Laravel, and Gatsby.
  • Community Forum: Join our developer forum to discuss issues and solutions with other users.

Let’s build fraud-free and secure applications together! 🚀