Skip to main content

API Reference

Complete documentation for the botsKYC REST API.

API Endpoints​

Quick Reference

Complete endpoint reference with request/response examples and code snippets.

View Endpoints →

Architecture

Learn integration patterns, error handling, rate limits, and best practices.

Integration Guide →

Document Types

Explore supported identity documents and their formats.

Document Types →

🔔 Webhooks

Set up real-time notifications for verification events and results.

Configure Webhooks →

Quick Start​

Authentication​

All API requests require OAuth2 authentication. First, get your credentials:

  1. Sign up: Visit Developer Portal
  2. Create Application: Register your app and subscribe to BotsKYC API
  3. Get Credentials: Generate Client ID and Client Secret

Get Access Token​

curl -X POST https://api.botskyc.com/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Call API with Token​

curl https://api.botskyc.com/v1/kyc/documents/verify \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: multipart/form-data"

### Base URL

https://api.botskyc.com


### Response Format

All responses are in JSON:

```json
{
  "status": "success",
  "documentType": "OMANG",
  "data": {
    "fullName": "John Doe",
    "idNumber": "456789"
  }
}

Main Endpoints​

Identity Verification​

POST /api/kyc/analyze/identity

Verify identity documents (ID cards, passports, driver's licenses)

Address Verification​

POST /api/kyc/analyze/address

Verify address documents (utility bills, bank statements)

Liveness Detection​

POST /api/kyc/liveness/verify

Perform face liveness verification

Document Auto-Detection​

POST /api/kyc/analyze/auto

Automatically detect and verify any document type

Key Features​

High Performance​

  • 2-5 second response time
  • 95-99% accuracy
  • Multi-document processing
  • Batch operations support

Secure and Reliable​

  • TLS 1.3+ encryption
  • API key authentication
  • Rate limiting
  • Request validation

🇼 Botswana-Optimized​

  • Key Botswana document types (Omang, passports, driver's licenses)
  • Omang, passports, drivers licenses
  • Optimized for local formats

📊 Rate Limits​

PlanPer MinutePer DayConcurrent
Free101001
Starter601,0005
Pro20010,00010
EnterpriseCustomCustomCustom

API Documentation​

Core Resources​

Support​

Need help integrating?