# Idswyft

> Open-source identity verification platform. Verify government-issued IDs with OCR, cross-validation, liveness detection, and face matching.

## Overview

Idswyft provides a REST API for identity verification. Developers integrate via API key (`X-API-Key: ik_...`) to run a 5-step pipeline: front document OCR, back document barcode/MRZ, cross-validation, liveness detection, and face matching. All decisions are deterministic — no LLMs in the decision pipeline.

Self-hostable via Docker Compose (4 containers) or available as managed cloud at idswyft.app.

## Quick Links

- [Full API Documentation](https://idswyft.app/llms-full.txt): Complete API reference in markdown (llms-full.txt)
- [API Docs (Backend)](https://api.idswyft.app/api/docs/markdown): Machine-readable API docs served by the API
- [Developer Portal](https://idswyft.app/developer): Register, get API keys, manage webhooks
- [Live Demo](https://idswyft.app/demo): Try the verification flow in sandbox mode
- [Documentation](https://idswyft.app/docs): Interactive documentation
- [GitHub](https://github.com/team-idswyft/idswyft): Source code (MIT license)

## SDKs

- JavaScript/TypeScript: `npm install @idswyft/sdk`
- React Component: `npm install @idswyft/react`
- Python: `pip install idswyft`

## Verification Flow

```
POST /api/v2/verify/initialize          → Create session
POST /api/v2/verify/:id/front-document  → OCR extraction
POST /api/v2/verify/:id/back-document   → Barcode/MRZ + cross-validation
POST /api/v2/verify/:id/live-capture    → Liveness + face match
GET  /api/v2/verify/:id/status          → Poll for final result
```

## Verification Modes

| Mode | Steps | Use Case |
|------|-------|----------|
| `full` (default) | Front → Back → CrossVal → Live → FaceMatch | Full identity verification |
| `document_only` | Front → Back → CrossVal | Document checks, no biometric |
| `identity` | Front → Live → FaceMatch | Quick identity check, no back doc |
| `age_only` | Front (DOB check) | Age-gated content (18+/21+) |

## Integration Options

1. **Redirect** — send users to `idswyft.app/user-verification?api_key=...&user_id=...`
2. **Iframe** — embed the hosted page with `allow="camera; microphone"`
3. **SDK** — `@idswyft/sdk` IdswyftEmbed (modal/inline) or `@idswyft/react` React component

## Base URLs

- Cloud API: `https://api.idswyft.app`
- Cloud Frontend: `https://idswyft.app`
- Self-hosted: configured via Docker Compose

## Version

v1.8.2 — April 2026