Getting Started with YeboVerify

YeboVerify is a B2B identity verification API that helps businesses verify the identity of their users through facial recognition and document verification.

Overview

YeboVerify offers two verification modes:

1. Selfie Match - Compare a selfie against a profile picture URL
2. ID Document Verification - Full identity verification with face matching and OCR extraction

Quick Start

1. Get Your API Key

Contact us at support@yeboverify.com to register your business and receive your API key.

2. Choose Your Verification Mode

Mode	Use Case	Processing Time
Selfie Match	Quick face comparison (e.g., profile verification)	~2-3 seconds
ID Document	Full KYC with document data extraction	~5-10 seconds

3. Make Your First API Call

curl -X POST https://api.yeboverify.com/v1/verify/selfie-match \
  -H "X-API-Key: your_api_key" \
  -F "selfie=@selfie.jpg" \
  -F "profilePictureUrl=https://example.com/profile.jpg"

Base URL

https://api.yeboverify.com

Authentication

All API requests require an X-API-Key header:

X-API-Key: your_api_key_here

Response Format

All responses follow this format:

{
  "success": true,
  "data": {
    // Response data here
  }
}

Error responses:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

Verification Flow

Synchronous Verification (Recommended)

Both verification modes return results immediately:

┌─────────────────┐       ┌─────────────────┐
│   Your App      │       │   YeboVerify    │
└────────┬────────┘       └────────┬────────┘
         │                         │
         │  POST /v1/verify/*      │
         │────────────────────────>│
         │                         │
         │  ◄── Instant Response ──│
         │  (verification result)  │
         │<────────────────────────│

Async Verification (Sessions)

For complex flows where you need to redirect users:

┌─────────────────┐       ┌─────────────────┐       ┌─────────────────┐
│   Your App      │       │   YeboVerify    │       │   User Browser  │
└────────┬────────┘       └────────┬────────┘       └────────┬────────┘
         │                         │                         │
         │  POST /v1/sessions/     │                         │
         │    create               │                         │
         │────────────────────────>│                         │
         │                         │                         │
         │  ◄── Session Token ────│                         │
         │<────────────────────────│                         │
         │                         │                         │
         │                         │  Redirect to verifyUrl  │
         │─────────────────────────┼────────────────────────>│
         │                         │                         │
         │                         │  ◄── Complete Flow ───  │
         │                         │<────────────────────────│
         │                         │                         │
         │  ◄── Webhook ──────────│                         │
         │<────────────────────────│                         │

Rate Limits

Plan	Requests/minute	Verifications/month
Free	10	100
Starter	60	1,000
Business	300	10,000
Enterprise	Custom	Custom

Next Steps

• API Reference - Complete endpoint documentation
• Code Examples - Implementation examples in various languages
• Webhooks - Configure webhook notifications
• Error Codes - Complete error reference