Skip to main content

BotsKYC Setup Guide

This guide helps you start using the public BotsKYC API quickly.

Prerequisites​

  • An active BotsKYC account
  • API access provisioned for your project (contact support if you don’t have this yet)

Base URL​

Production: https://api.botskyc.com

Authentication​

If your account is configured with an API key, include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Note: Sandbox environments may not require authentication; production does. If you’re unsure, reach out to support.

Try it with cURL​

Identity example (multipart/form-data):

curl -X POST https://api.botskyc.com/api/kyc/analyze/identity
-H "Authorization: Bearer YOUR_API_KEY"
-F "documents=@omang_front.jpg"
-F "documents=@omang_back.jpg"

Liveness session example:

curl -X POST https://api.botskyc.com/v1/liveness/session
-H "Authorization: Bearer $TOKEN"

Postman Collection​

Download and import the collection: BotsKYC-API.postman_collection.json, then set the base URL and Authorization header in a Postman environment.

Common endpoints​

  • POST /api/kyc/analyze/identity
  • POST /api/kyc/analyze/address
  • POST /api/kyc/analyze/income
  • POST /api/kyc/analyze/entity
  • POST /api/kyc/analyze/compliance
  • POST /api/kyc/analyze/multipurpose
  • POST /api/kyc/analyze/auto

Liveness:

  • POST /v1/liveness/session
  • GET /v1/liveness/session/:sessionId/results
  • POST /v1/liveness/verify/:sessionId
  • POST /v1/liveness/compare-faces
  • POST /api/kyc/analyze/identity-with-liveness

See API details in api/quick-reference.md, api/architecture.md, and liveness/api-reference.md.

File upload limits​

  • Max 10 files per request
  • Recommended file size: up to 10MB per file
  • Supported formats: JPEG, PNG, PDF (images preferred for faster processing)

Webhooks (optional)​

For asynchronous processing, configure a webhook endpoint on your side and follow api/webhooks.md for payload and signature verification.

Errors​

Errors follow RFC 7807 style. Common types:

  • validation-error (400)
  • document-processing-error (422)
  • ai-service-error (503)
  • storage-error (500)
  • internal-error (500)

Support​