title: FAQ description: This section provides answers to frequently asked questions about Hive Forensics AI's products and services.
Overview
Welcome to the FAQ section. Here, you'll find answers to common questions about using Hive Forensics AI's APIs, including the Fraud Buster API and the Spektrum API. This section is designed to help you troubleshoot issues, understand our services better, and get the most out of our products.
Content
- Introduction: Overview of our APIs and their functionalities.
- API Key Management: How to obtain and secure your API key.
- Integration Guidance: Best practices for integrating our APIs into your application.
- Troubleshooting: Solutions to common problems users encounter.
- FAQ: Frequently Asked Questions.
Getting Started
Step 1: Introduction
The FAQ section introduces you to the core concepts and functionalities of Hive Forensics AI's products. It is designed to help you understand the essentials and get started quickly.
Step 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, navigate to the API section in your dashboard to generate and manage your API keys.
How should I secure my API key?
Always keep your API key secure by storing it in environment variables or a secure vault. Avoid hardcoding the API key in your application's codebase, especially in client-side code.
Step 3: Integration Guidance
What are the best practices for integrating the Fraud Buster API?
- Ensure you have set up your environment correctly with the required dependencies.
- Use HTTPS for all API requests to secure the data in transit.
- Handle API responses gracefully by checking the status codes and managing errors appropriately.
How do I upload images for identity verification using the Spektrum API?
To upload images using the Spektrum API, ensure that the image file is in the correct format (e.g., PNG or JPEG). Use a multipart/form-data request to send the image along with the required headers for authentication.
Step 4: Troubleshooting
I’m receiving a 401 Unauthorized error. What should I do?
A 401 error typically means that your API key is missing or incorrect. Double-check that you’ve included the correct API key in the request headers and that it is valid. If the problem persists, try regenerating your API key from the Hive Forensics AI portal.
The API response times are slow. How can I improve performance?
If you experience slow response times, consider the following:
- Optimize your request payloads to send only the necessary data.
- Ensure your network connection is stable and has sufficient bandwidth.
- Contact our support team if the issue persists, as there may be temporary service disruptions.
Step 5: FAQ
Here are some frequently asked questions:
Can I use Hive Forensics AI’s APIs for real-time fraud detection?
Yes, our APIs are designed to be used in real-time scenarios. Ensure that your application is configured to handle asynchronous requests and process the API responses as soon as they are received.
What types of images are supported by the Spektrum API for identity verification?
The Spektrum API supports PNG, JPEG, and other common image formats. Make sure the image is clear, well-lit, and meets any other guidelines provided in the documentation.
How do I handle rate limiting on Hive Forensics AI’s APIs?
Our APIs implement rate limiting to ensure fair usage. If you hit the rate limit, you will receive a 429 Too Many Requests response. Implement exponential backoff in your application to handle retries and avoid being throttled.