API Reference
The Kora IDV API is organized around REST. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP status codes.
Base URL
https://api.korastratum.com/api/v1/idv
Authentication
All endpoints require two headers:
Authorization: Bearer <your-api-key>
X-Tenant-ID: <your-tenant-id>
See Authentication for details on API key formats and environments.
Endpoints
Verifications
| Method | Endpoint | Description |
|---|---|---|
POST | /verifications | Create a new verification session |
GET | /verifications/{id} | Retrieve a verification by ID |
GET | /subjects/{subjectId}/verifications | List verifications for a subject |
POST | /verifications/{id}/complete | Complete verification and get decision |
POST | /verifications/{id}/review | Submit a manual review decision |
Documents
| Method | Endpoint | Description |
|---|---|---|
POST | /verifications/{id}/document | Upload document front image |
POST | /verifications/{id}/document/back | Upload document back image |
Biometrics
| Method | Endpoint | Description |
|---|---|---|
POST | /verifications/{id}/selfie | Upload a selfie image |
Liveness
| Method | Endpoint | Description |
|---|---|---|
POST | /verifications/{id}/liveness/session | Create a liveness session |
POST | /verifications/{id}/liveness/challenge | Submit a liveness challenge response |
POST | /verifications/{id}/liveness/frames | Submit video frames for temporal analysis |
GET | /verifications/{id}/liveness | Get liveness session result |
Images
| Method | Endpoint | Description |
|---|---|---|
GET | /verifications/{id}/images | List available verification images |
GET | /verifications/{id}/images/{imageType} | Get a signed URL for an image |
Fraud Alerts
| Method | Endpoint | Description |
|---|---|---|
GET | /alerts | List fraud alerts |
POST | /alerts/{id}/resolve | Resolve a fraud alert |
Reference
| Method | Endpoint | Description |
|---|---|---|
GET | /document-types | List supported document types |
GET | /health | Health check (no auth required) |
Response format
Successful responses return the resource directly:
{
"id": "ver_abc123",
"status": "pending",
"tier": "standard",
"createdAt": "2025-01-15T10:30:00Z"
}
Error responses follow a consistent structure:
{
"code": "VALIDATION_ERROR",
"error": "Missing required field 'externalId'",
"details": {
"field": "externalId",
"constraint": "required"
}
}
See Error Codes for the complete list.