BotsKYC API

Identity Verification

Endpoint:https://api.botskyc.com

Identity document verification and biometric authentication services.

Available Now:

ID Scan - Extract data from Omang, Passport, and Driver's License
Liveness Check - Real-time biometric verification with anti-spoofing
Face Match - Compare selfie to document photo

Coming Soon:

ID Verify - Validate against Omang Office database (Q1 2026)

ID Verify - Validate Against Government Database

POST

https://api.botskyc.com

/identity/verify

Validate identity documents against government databases (Omang Office, Immigration). Status: Coming Q1 2026.

ID Verify - Validate Against Government Database › 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.

ID Verify - Validate Against Government Database › Request Body

No data returned

ID Verify - Validate Against Government Database › Responses

200

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/identity/verify

curl --request POST \
  --url https://api.botskyc.com/identity/verify \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Request Body Example

{}

json

ID Scan - Extract Data from Identity Documents

POST

https://api.botskyc.com

/identity/scan

Extract structured data from Omang, Passport, or Driver's License. Supports batch processing and automatic front/back merging.

ID Scan - Extract Data from Identity Documents › query Parameters

documents

string[] · required

ID Scan - Extract Data from Identity 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

ID Scan - Extract Data from Identity Documents › Responses

Identity 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/identity/scan

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

shell

Liveness Check - Confirm Real Person (Anti-Spoofing)

POST

https://api.botskyc.com

/identity/liveness

Create liveness session to verify customer is a real person, not a photo or video. Includes multi-challenge face detection and anti-spoofing technology.

Liveness Check - Confirm Real Person (Anti-Spoofing) › 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

Liveness Check - Confirm Real Person (Anti-Spoofing) › Request Body

Liveness session creation request

client_session_id

string

Optional client-provided session identifier for tracking

object

Optional settings for the liveness session

Liveness Check - Confirm Real Person (Anti-Spoofing) › Responses

Response containing AWS Rekognition liveness session details for client-side verification

session_id

string · required

Unique session identifier to use for liveness verification

status

string · enum · required

Current status of the liveness session

Enum values:

CREATED

IN_PROGRESS

SUCCEEDED

FAILED

EXPIRED

created_at

string · date-time · required

ISO-8601 timestamp when the session was created

expires_at

string · date-time · required

ISO-8601 timestamp when the session will expire (typically 15 minutes after creation)

POST/identity/liveness

curl --request POST \
  --url https://api.botskyc.com/identity/liveness \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_session_id": "client_abc123",
  "settings": {
    "audit_images_limit": 4
  }
}
'

shell

Request Body Example

{
  "client_session_id": "client_abc123",
  "settings": {
    "audit_images_limit": 4
  }
}

json

Face Match - Compare Selfie to ID Photo

POST

https://api.botskyc.com

/identity/face-match

Compare selfie photo to ID document photo to verify same person. Returns similarity confidence score.

Face Match - Compare Selfie to ID Photo › 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

Face Match - Compare Selfie to ID Photo › Request Body

selfie

string · binary · required

Selfie image or liveness session result

idDocument

string · binary · required

ID document photo or full document image

Face Match - Compare Selfie to ID Photo › Responses

Result of AWS Rekognition face comparison between two images with similarity score and quality metrics

similarity

number · double · min: 0 · max: 100 · required

Similarity score between the two faces (0-100, where 100 is identical)

is_match

boolean · required

Boolean indicating if the faces match based on the threshold

confidence

number · double · min: 0 · max: 100

Confidence score for the face comparison (typically same as similarity)

threshold

number · double

Threshold used to determine if faces match (default: 80.0)

object

Quality metrics for the source image (first image compared)

object

Quality metrics for the target image (second image compared)

message

string

Human-readable message about the face match result

POST/identity/face-match

curl --request POST \
  --url https://api.botskyc.com/identity/face-match \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "selfie": "selfie",
  "idDocument": "idDocument"
}
'

shell

Request Body Example

{
  "selfie": "selfie",
  "idDocument": "idDocument"
}

json

Identity Verification Roadmap

GET

https://api.botskyc.com

/identity/roadmap

View all identity products - both available now and coming soon

Identity Verification Roadmap › Responses

200

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

GET

https://api.botskyc.com

/identity/liveness/{sessionId}/results

path Parameters

sessionId

string · required

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

Responses

200

Result of AWS Rekognition face liveness verification with confidence score and audit images

session_id

string · required

Unique session identifier for this liveness verification

status

string · enum · required

Status of the liveness verification

Enum values:

SUCCEEDED

FAILED

PENDING

confidence

number · double · min: 0 · max: 100 · required

Confidence score of liveness detection (0-100, where 100 is highest confidence)

is_live

boolean · required

Boolean indicating if the person is determined to be live (not a spoof)

reference_image

string

Base64-encoded reference image captured during liveness check

audit_images

string[]

Array of base64-encoded audit images captured during the liveness check process

created_at

string · date-time

ISO-8601 timestamp when the session was created

message

string

Human-readable message about the verification result

GET/identity/liveness/{sessionId}/results

curl --request GET \
  --url https://api.botskyc.com/identity/liveness/:sessionId/results \
  --header 'Authorization: <string>'

shell

Document Processing

ID Verify - Validate Against Government Database

POST

https://api.botskyc.com

/identity/verify

Validate identity documents against government databases (Omang Office, Immigration). Status: Coming Q1 2026.

ID Verify - Validate Against Government Database › 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.

ID Verify - Validate Against Government Database › Request Body

No data returned

ID Verify - Validate Against Government Database › Responses

200

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

ID Scan - Extract Data from Identity Documents

POST

https://api.botskyc.com

/identity/scan

Extract structured data from Omang, Passport, or Driver's License. Supports batch processing and automatic front/back merging.

ID Scan - Extract Data from Identity Documents › query Parameters

documents

string[] · required

ID Scan - Extract Data from Identity 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

ID Scan - Extract Data from Identity Documents › Responses

Identity 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

Liveness Check - Confirm Real Person (Anti-Spoofing)

POST

https://api.botskyc.com

/identity/liveness

Create liveness session to verify customer is a real person, not a photo or video. Includes multi-challenge face detection and anti-spoofing technology.

Liveness Check - Confirm Real Person (Anti-Spoofing) › 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

Liveness Check - Confirm Real Person (Anti-Spoofing) › Request Body

Liveness session creation request

client_session_id

string

Optional client-provided session identifier for tracking

object

Optional settings for the liveness session

Liveness Check - Confirm Real Person (Anti-Spoofing) › Responses

Response containing AWS Rekognition liveness session details for client-side verification

session_id

string · required

Unique session identifier to use for liveness verification

status

string · enum · required

Current status of the liveness session

Enum values:

CREATED

IN_PROGRESS

SUCCEEDED

FAILED

EXPIRED

created_at

string · date-time · required

ISO-8601 timestamp when the session was created

expires_at

string · date-time · required

ISO-8601 timestamp when the session will expire (typically 15 minutes after creation)

Face Match - Compare Selfie to ID Photo

POST

https://api.botskyc.com

/identity/face-match

Compare selfie photo to ID document photo to verify same person. Returns similarity confidence score.

Face Match - Compare Selfie to ID Photo › 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

Face Match - Compare Selfie to ID Photo › Request Body

selfie

string · binary · required

Selfie image or liveness session result

idDocument

string · binary · required

ID document photo or full document image

Face Match - Compare Selfie to ID Photo › Responses

Result of AWS Rekognition face comparison between two images with similarity score and quality metrics

similarity

number · double · min: 0 · max: 100 · required

Similarity score between the two faces (0-100, where 100 is identical)

is_match

boolean · required

Boolean indicating if the faces match based on the threshold

confidence

number · double · min: 0 · max: 100

Confidence score for the face comparison (typically same as similarity)

threshold

number · double

Threshold used to determine if faces match (default: 80.0)

object

Quality metrics for the source image (first image compared)

object

Quality metrics for the target image (second image compared)

message

string

Human-readable message about the face match result

Identity Verification Roadmap

GET

https://api.botskyc.com

/identity/roadmap

View all identity products - both available now and coming soon

Identity Verification Roadmap › Responses

200

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