title: Spektrum API Quick Start Guide description: This section provides an overview of the Quick Start Guide for integrating Hive Forensics AI's Spektrum API.
Overview
Welcome to the Spektrum API
section. This guide provides all the information you need to integrate Hive Forensics AI’s Spektrum API, which helps verify identity through image analysis and ID verification.
Content
- Introduction: Overview of the Spektrum API.
- API Setup: Step-by-step guide to configure your API environment.
- API Usage: Examples of how to use the Spektrum API.
- Response Handling: How to interpret API responses.
- FAQ: Frequently Asked Questions.
Getting Started
Step 1: Introduction
Spektrum API is designed to verify the identity of individuals through image analysis, using advanced AI algorithms. You can submit images, and the API will return the verification results.
Step 2: API Setup
Follow these steps to set up your environment:
-
Install Required Tools:
- Node.js for JavaScript development
- Python for Python-based development
- A code editor (like VSCode)
-
Obtain Your API Key: Get your API key from the Hive Forensics AI portal. You’ll need this key to authenticate your API requests.
-
Create a Configuration File: Set up a configuration file in your project to store your API key securely. Example for
.env
:API_KEY=your-api-key-here
Step 3: Configuration
-
Integrate the API Key: Add your API key to your project’s environment configuration. For example, in Node.js:
const apiKey = process.env.API_KEY;
-
Set Up Base URL: Define the base URL for the Spektrum API in your application’s configuration:
const spektrumApiUrl = 'http://localhost:3000/assess-id';
Step 4: API Usage
Spektrum API for Identity Verification
Endpoint: POST http://localhost:3000/assess-id
Headers:
{
"Content-Type": "multipart/form-data",
"x-api-key": "YOUR_API_KEY"
}
Request Payload:
--form 'image
=@"/path/to/your/image.png"'
Example in cURL
curl --location 'http://localhost:3000/assess-id' \
--form 'image=@"/path/to/your/image.png"' \
-H "x-api-key: YOUR_API_KEY"
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.
---
### Summary:
- **fraud-buster.mdx** is dedicated to the **Fraud Buster API**, with detailed usage examples, payload structure, and Python/JavaScript code snippets.
- **spektrum.mdx** is dedicated to the **Spektrum API**, focusing on identity verification with file uploads via `multipart/form-data`, and examples in cURL and Python.