Hive Forensics - Introduction

Welcome to Hive Forensics Documentation

Overview

Welcome to the Hive Forensics documentation portal! Here, you'll find everything you need to integrate and use our fraud detection and identity verification APIs.

Whether you're a developer looking for quick API setup instructions or a business owner aiming to protect your transactions, this guide is your starting point.

Getting Started

To begin using Hive Forensics APIs, follow these simple steps:

1. Obtain Your API Key:
   Register on our platform to obtain your unique API key. This key is required to authenticate all API requests.

2. Install Required Tools:
   Ensure that your development environment is set up with tools like Node.js, Python, Composer (PHP), or Gatsby CLI, based on your preferred language or framework.

3. Configure Environment Variables:
   Securely store your API key and endpoint URL using environment variables to avoid exposing sensitive data in your code.

4. Make Your First API Call:
   Follow the examples provided in our guides for React, Node.js, Laravel, or Gatsby to make your first API call and integrate our services seamlessly.

Why Choose Hive Forensics?

• Cutting-Edge AI Technology:
  Leverage advanced fraud detection and identity verification algorithms.

• Cross-Platform Compatibility:
  Works seamlessly with React, Node.js, Laravel, and Gatsby frameworks.

• Customizable Strictness:
  Fine-tune fraud detection levels to match your business needs.

• Real-Time Analysis:
  Instant feedback for transaction evaluations and risk scores.

Key Features

• Fraud Buster API:
  Detect and prevent fraudulent activities in online transactions.

• Spektrum API:
  Perform identity verification using advanced image analysis.

• Flexible Integrations:
  Use our APIs with any modern framework or backend system.

Security Best Practices

"Always keep your API keys secure. Never expose them in client-side code. Use environment variables or secure vaults for managing sensitive information."

• Use HTTPS to encrypt API communication.
• Restrict API access by IP whitelisting or token expiration policies.
• Regularly rotate API keys to minimize risk.

Code Examples with Tab Switcher

To make it easier for developers using different languages, our examples support language switching. Here’s an example of a React component using the Fraud Buster Client:

import FraudBusterClient from 'fraud-buster-client';

const fraudClient = new FraudBusterClient({
  apiKey: process.env.REACT_APP_API_KEY,
});

const checkTransaction = async () => {
  const data = {
    product: "Rolex Watch",
    amount: 9500,
    location: "Florida",
  };
  const response = await fraudClient.evaluateTransaction(data);
  console.log(response);
};

Project Structure

Our documentation follows a clean and intuitive structure, making it easy to navigate and expand as needed.

root
├── app
├── content
│   └── docs
│       ├── getting-started
│       │   ├── introduction.mdx   /* Start here */
│       │   ├── installation.mdx
│       │   └── faq.mdx
└── package.json

To modify routes or update navigation, edit the routes.config.ts file:

export const ROUTES = [
  {
    title: "Getting Started",
    href: "getting-started",
    items: [
      { title: "Introduction", href: "/introduction" },
      { title: "Installation", href: "/installation" },
      { title: "FAQ", href: "/faq" },
    ],
  },
];

Example API Request

curl --location 'http://localhost:8000/api/transaction' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data-raw '{
  "product": "Rolex Watch",
  "amount": 9500,
  "location": "Florida"
}'

Risk Level Definitions

How to Get Support?

• Documentation: Refer to the detailed guides and examples provided.
• FAQ: Check our Frequently Asked Questions section for quick answers.
• Contact Us: Reach out to our support team for personalized assistance.

Next Steps

Now that you’re familiar with the basics, head over to our installation guides for frameworks like React, Node.js, Laravel, and Gatsby to integrate Hive Forensics APIs into your application.

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