BotsKYC API

Document Processing

Endpoint:https://api.botskyc.com

Extract structured data from various document types for KYC compliance.

Available Now:

Document Scan - Auto-detect and extract from any document type
Address Scan - Extract address from utility bills and lease agreements
Income Scan - Extract salary information from payslips

Coming Soon:

Fraud Detection - Identify tampered or forged documents (Q2 2026)

Document Scan - Auto-Extract from Any Document

POST

https://api.botskyc.com

/documents/scan

Auto-detect document type and extract relevant data. Routes to specialized extractors. Supports address proof, income proof, ID documents, and business documents.

Document Scan - Auto-Extract from Any Document › query Parameters

documents

string[] · required

Document Scan - Auto-Extract from Any Document › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

x-customer-id

string

authorization

string

Document Scan - Auto-Extract from Any Document › Responses

Document processed and data extracted successfully

Complete verification response with document results, summary statistics, and processing metadata

requestId

string · required

Unique identifier for this verification request

timestamp

string · date-time · required

ISO-8601 formatted timestamp when the verification was processed

verificationType

string · enum · required

The type of verification that was performed

Enum values:

IDENTITY

ADDRESS

INCOME

ENTITY

COMPLIANCE

MULTIPURPOSE

status

string · enum · required

Overall status of the verification request

Enum values:

success

partial_success

failure

object[] · required

Array of individual document verification results

object · required

Aggregate statistics across all processed documents

object

Technical metadata about how the verification was processed

POST/documents/scan

curl --request POST \
  --url 'https://api.botskyc.com/documents/scan?documents=%3Cvalue%3E' \
  --header 'Authorization: <string>'

shell

Income Scan - Extract Salary from Payslips

POST

https://api.botskyc.com

/documents/income/scan

Extract gross/net salary, deductions, and employer details from payslips. Supports all payslip formats with 95%+ accuracy for loan affordability checks.

Income Scan - Extract Salary from Payslips › query Parameters

documents

string[] · required

Income Scan - Extract Salary from Payslips › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

x-customer-id

string

authorization

string

Income Scan - Extract Salary from Payslips › Responses

Income data extracted successfully

Complete verification response with document results, summary statistics, and processing metadata

requestId

string · required

Unique identifier for this verification request

timestamp

string · date-time · required

ISO-8601 formatted timestamp when the verification was processed

verificationType

string · enum · required

The type of verification that was performed

Enum values:

IDENTITY

ADDRESS

INCOME

ENTITY

COMPLIANCE

MULTIPURPOSE

status

string · enum · required

Overall status of the verification request

Enum values:

success

partial_success

failure

object[] · required

Array of individual document verification results

object · required

Aggregate statistics across all processed documents

object

Technical metadata about how the verification was processed

POST/documents/income/scan

curl --request POST \
  --url 'https://api.botskyc.com/documents/income/scan?documents=%3Cvalue%3E' \
  --header 'Authorization: <string>'

shell

Document Verify - Fraud Detection

POST

https://api.botskyc.com

/documents/fraud-detect

AI-powered fraud detection to identify tampered, forged, or fake documents. Detects Photoshop, PDF manipulation, and known forgery patterns. Status: Coming Q2 2026.

Document Verify - Fraud Detection › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Document Verify - Fraud Detection › Request Body

document

string · binary · required

Document to analyze for fraud/tampering (payslips, utility bills, etc.). Supports JPG, PNG, PDF.

Document Verify - Fraud Detection › Responses

Service coming soon - expected Q2 2026

Response for upcoming services in development

service

string

Name of the service

status

string · enum

Current status of the service

Enum values:

COMING_SOON

IN_DEVELOPMENT

BETA

availableDate

string

Expected availability date

description

string

Detailed description of what the service does

features

string[]

Key features that will be available

contactEmail

string

Contact email for more information or early access

notifyUrl

string

URL to sign up for launch notifications

documentationUrl

string

Link to documentation about the upcoming service

POST/documents/fraud-detect

curl --request POST \
  --url https://api.botskyc.com/documents/fraud-detect \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "document"
}
'

shell

Request Body Example

{
  "document": "document"
}

json

Address Scan - Extract Address from Documents

POST

https://api.botskyc.com

/documents/address/scan

Extract address details from utility bills, lease agreements, and council bills. Supports WUC, BPC, council rates, and bank statements.

Address Scan - Extract Address from Documents › query Parameters

documents

string[] · required

Address Scan - Extract Address from Documents › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

x-customer-id

string

authorization

string

Address Scan - Extract Address from Documents › Responses

Address extracted successfully

Complete verification response with document results, summary statistics, and processing metadata

requestId

string · required

Unique identifier for this verification request

timestamp

string · date-time · required

ISO-8601 formatted timestamp when the verification was processed

verificationType

string · enum · required

The type of verification that was performed

Enum values:

IDENTITY

ADDRESS

INCOME

ENTITY

COMPLIANCE

MULTIPURPOSE

status

string · enum · required

Overall status of the verification request

Enum values:

success

partial_success

failure

object[] · required

Array of individual document verification results

object · required

Aggregate statistics across all processed documents

object

Technical metadata about how the verification was processed

POST/documents/address/scan

curl --request POST \
  --url 'https://api.botskyc.com/documents/address/scan?documents=%3Cvalue%3E' \
  --header 'Authorization: <string>'

shell