> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dataspike.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> A high-level guide to how the Dataspike API works, including environments, auth, and the core identity and compliance endpoints.

The Dataspike API is a unified AI interface for identity verification, document intelligence, AML screening, deepfake detection, crypto risk analysis (KYT), and real-time behavioral and device analytics.
All endpoints follow predictable JSON schemas, standard HTTP semantics, and are optimized for low-latency, high-throughput inference at scale.

Whether you’re building onboarding flows, fraud prevention pipelines, or real-time risk engines, Dataspike provides a single, consistent API layer that abstracts complex AI systems into simple, reliable REST calls.

***

## 🌐 Base URLs

Use the appropriate environment for development, testing, or production workloads:

| Environment    | Base URL                          | Purpose                                                                               |
| -------------- | --------------------------------- | ------------------------------------------------------------------------------------- |
| **Sandbox**    | `https://sandboxapi.dataspike.io` | Safe testing environment for local development, QA, and simulated verifications.      |
| **Production** | `https://api.dataspike.io`        | Live environment for real identity checks, AML screenings, and compliance operations. |

Each environment has its **own API key** and isolated data model.

***

## 🔑 Authentication

All API requests must be authenticated using your environment-specific API key.

You can generate and manage keys from the **Dashboard → API** section:\
👉 [https://dash.dataspike.io/api](https://dash.dataspike.io/api)

Keys for Sandbox and Production are **not interchangeable**.

### Required headers

```http theme={null}
Content-Type: application/json
ds-api-token: <YOUR_API_KEY>
```

* `Content-Type` must always be `application/json`
* `ds-api-token` authenticates your request
* Missing or invalid tokens return `401 Unauthorized`

***

## 📡 Making requests

The API uses standard HTTP methods:

| Method          | Purpose                                          |
| --------------- | ------------------------------------------------ |
| **GET**         | Retrieve resources                               |
| **POST**        | Create new resources or submit verification data |
| **PUT / PATCH** | Update existing resources                        |
| **DELETE**      | Remove or deactivate resources                   |

All responses are JSON and include consistent result structures and status codes.

### Example request

```bash theme={null}
curl -X GET "https://api.dataspike.io/v1/applicants"   -H "Content-Type: application/json"   -H "ds-api-token: <YOUR_API_KEY>"
```

***

## 🔔 Webhooks

Use **webhooks** to receive real-time notifications when key events occur — such as completed verifications, AML matches, or KYT address alerts.

Configure webhooks under:\
**Dashboard → API → Webhooks**

Each environment (Sandbox & Production) has its own webhook configuration and delivery logs.

Common webhook event types include:

* `AML Screening`
* `Docver Check`
* `Deepfake Video Analysis`

Webhook payloads follow the same JSON schemas used by the API.

***

## 🧱 Core API Domains

**Applicants**\
Persistent identity records that link all workflows — verifications, AML checks, KYT crypto analysis, deepfake signals, and behavioral risk events.

**Verification**\
Document checks, biometric matching, liveness detection, and selfie-to-ID comparison. Works for both applicant-linked flows and fully stateless sessions.

**Deepfake Analysis**\
Detection of AI-generated or manipulated identity media across images, uploaded videos, and real-time video streams — including WebRTC, LiveKit, Google Meet, and other streaming platforms.

**AML Screening**\
Global sanctions, watchlist, PEP, and adverse-media checks with automated scoring and continuous monitoring.

**KYT (Crypto Risk Intelligence)**\
Risk evaluation for blockchain addresses and transactions: sanctions exposure, wallet behavior analysis, clustering heuristics, and counterparty intelligence.

**Document Intelligence**\
AI models for document classification, structured data extraction, and fraud pattern detection.

**Webhooks**\
Real-time events for verifications, AML matches, KYT alerts, deepfake outcomes, and applicant updates.