Quickstart

Get up and running with the BotsKYC API in minutes.

1. Get an API Key

Register on the BotsKYC Portal to receive your API key.

2. Make Your First Request

Scan an identity document:

Code
 
curl -X POST https://api.botskyc.com/v1/identity/scan \
  -H "x-api-key: YOUR_API_KEY" \
  -F "[email protected]"

3. Check the Response

Code
 
{
  "documentType": "OMANG",
  "extractedData": {
    "idNumber": "123456789",
    "firstName": "JOHN",
    "lastName": "MODISE",
    "dateOfBirth": "1990-01-15",
    "gender": "M",
    "nationality": "BWA"
  },
  "confidence": 0.97
}

Common Workflows

Identity Onboarding (Full KYC)

1. POST /v1/identity/scan — Extract ID data
2. POST /v1/identity/validate — Validate extracted fields
3. POST /v1/identity/liveness — Create liveness session
4. GET /v1/identity/liveness/{sessionId}/results — Poll for result
5. POST /v1/identity/face-match — Compare selfie to ID photo
6. POST /v1/screening/screen/enhanced — Run sanctions/PEP check

Business Verification (KYB)

1. POST /v1/business/scan — Extract company registration data
2. POST /v1/business/verify — Verify against CIPA registry
3. POST /v1/screening/screen/enhanced — Screen directors/shareholders

Document Verification

1. POST /v1/documents/address/scan — Extract address from utility bill
2. POST /v1/forensics/address — Check for tampering