Skip to main content

Quick Start Guide

Get up and running with BotsKYC in minutes.

Prerequisites​

  • API credentials (request from support@botskyc.com)
  • A REST client (curl, Postman) or your application
  • Test documents (sample ID front/back, selfie)

Base URL: https://api.botskyc.com

Authentication: Bearer API key via Authorization header

1) Get your API key​

Email support@botskyc.com to receive your API key. Store it securely; treat it like a password.

2) Verify an identity document​

Use the analyze endpoints to send one or more images. Content-Type is multipart/form-data.

Example (identity only):

curl -X POST https://api.botskyc.com/api/kyc/analyze/identity \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "documents=@omang-front.jpg"

3) Testing with Postman​

  1. Download our Postman Collection
  2. Import it into Postman
  3. Set your API key in the collection variables
  4. Start testing endpoints

Security notes:

  • ⚠ Never commit secrets or .env files
  • Store API keys in Postman environments

Response Codes​

| Code | Meaning | |------|---------|| | 200 | Success - verification completed | | 400 | Bad Request - invalid input | | 401 | Unauthorized - invalid API key | | 404 | Not Found - session or resource not found | | 429 | Too Many Requests - rate limit exceeded | | 500 | Server Error - contact support |

Rate Limits​

  • Free Tier: 100 requests/day
  • Starter: 1,000 requests/day
  • Professional: 10,000 requests/day
  • Enterprise: Custom limits

Rate limits are enforced per API key. When exceeded, you'll receive a 429 Too Many Requests response with a Retry-After header indicating when you can retry.

Next Steps​

Now that you're up and running:

  1. Setup Guide - Detailed configuration and integration
  2. API Reference - Complete endpoint documentation
  3. Document Types - See all supported documents
  4. Webhooks - Set up event notifications

Need Help?​

Sample Code​

Check out our SDKs and sample code: