Documentation
/
API Reference

API Reference

Complete REST API documentation for Veriscopia. Build trust with our AI-powered verification infrastructure. All endpoints use JSON and feature enterprise-grade security.

POST
documents

Verify Document

Authenticate government-issued IDs with AI-powered validation

GET
documents

Get Verification

Retrieve verification results and audit trails

POST
biometrics

Face Match

Advanced liveness detection and facial recognition

POST
zkp

Create ZK Proof

Generate zero-knowledge proofs for privacy-preserving verification

Base URL
All API requests should be made to this endpoint
https://api.veriscopia.com/v1

Authentication

All API requests require authentication using your API key. Include it in the Authorization header. API keys provide full access to your account—keep them secure!

Request Header
Authorization: Bearer sk_live_1234567890abcdef

Document Verification

Verify Document
AI-powered authentication of government-issued IDs and passports
POST
Endpoint
/documents/verify
Request Body
{
  "document_image": "base64_encoded_image",
  "document_type": "passport",
  "country": "US",
  "enhanced_ai": true
}
Response
{
  "verification_id": "ver_1a2b3c4d5e",
  "status": "verified",
  "confidence": 0.987,
  "ai_model": "v2.4.1",
  "document_data": {
    "document_number": "123456789",
    "full_name": "John Doe",
    "date_of_birth": "1990-01-01"
  },
  "fraud_indicators": {
    "tamper_detected": false,
    "deepfake_risk": 0.02
  }
}

Biometric Matching

Face Match
Advanced liveness detection and facial recognition with anti-spoofing
POST
Endpoint
/biometrics/face-match
Request Body
{
  "selfie_image": "base64_encoded_image",
  "document_image": "base64_encoded_image",
  "liveness_check": true,
  "anti_spoofing": true
}
Response
{
  "match_id": "match_1a2b3c4d5e",
  "is_match": true,
  "similarity_score": 0.964,
  "liveness": {
    "is_live": true,
    "confidence": 0.992,
    "deepfake_detected": false
  }
}

Zero-Knowledge Proofs

Create ZK Proof
Generate privacy-preserving proofs without revealing sensitive data
POST
Endpoint
/zkp/create-proof
Request Body
{
  "credential_id": "cred_1a2b3c4d5e",
  "proof_type": "age_over",
  "threshold": 21,
  "privacy_level": "high"
}
Response
{
  "proof_id": "proof_1a2b3c4d5e",
  "proof_type": "age_over",
  "is_valid": true,
  "proof_hash": "0x1a2b3c...",
  "cryptographic_seal": true
}

Error Codes

Status
Code
Type
Description
400invalid_requestBad RequestInvalid request parameters
401unauthorizedUnauthorizedInvalid or missing API key
403forbiddenForbiddenInsufficient permissions
429rate_limitedRate LimitedToo many requests
500internal_errorServer ErrorInternal server error