BotsKYC API

Liveness Detection

Endpoint:https://api.botskyc.com

Real-time biometric verification with anti-spoofing protection.

Available Now:

Create Liveness Session - Initialize face liveness verification
Compare Faces - Match two face images with similarity scoring

POST

https://api.botskyc.com

/liveness/verify/{sessionId}

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.

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

POST/liveness/verify/{sessionId}

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

shell

POST

https://api.botskyc.com

/liveness/verify-with-document/{sessionId}

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.

Request Body

documentImage

string

Responses

200

object

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

object

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

overallSuccess

boolean

message

string

POST/liveness/verify-with-document/{sessionId}

curl --request POST \
  --url https://api.botskyc.com/liveness/verify-with-document/:sessionId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentImage": "documentImage"
}
'

shell

Request Body Example

{
  "documentImage": "documentImage"
}

json

Create Liveness Session

POST

https://api.botskyc.com

/liveness/session

Create AWS Rekognition liveness session for face verification. Client uses session ID with AWS SDK to perform liveness check, then retrieves results. Includes anti-spoofing and multi-challenge face detection.

Create Liveness Session › 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.

Create Liveness Session › Request Body

Liveness session creation request

client_session_id

string

Optional client-provided session identifier for tracking

object

Optional settings for the liveness session

Create Liveness Session › Responses

Liveness session created successfully

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/liveness/session

curl --request POST \
  --url https://api.botskyc.com/liveness/session \
  --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

Compare Faces

POST

https://api.botskyc.com

/liveness/compare-faces

Compare two face images and return similarity score (0-100) and match determination. Supports ID photo to selfie comparison with configurable threshold. Input: Base64-encoded images.

Compare Faces › 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.

Compare Faces › Request Body

Face comparison request with source and target images (Base64 encoded)

sourceImage

string

targetImage

string

Compare Faces › Responses

Face comparison completed successfully

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/liveness/compare-faces

curl --request POST \
  --url https://api.botskyc.com/liveness/compare-faces \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceImage": "sourceImage",
  "targetImage": "targetImage"
}
'

shell

Request Body Example

{
  "sourceImage": "sourceImage",
  "targetImage": "targetImage"
}

json

POST

https://api.botskyc.com

/liveness/compare-faces/validate

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.

Request Body

Face comparison request with source and target images (Base64 encoded)

sourceImage

string

targetImage

string

Responses

200

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/liveness/compare-faces/validate

curl --request POST \
  --url https://api.botskyc.com/liveness/compare-faces/validate \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceImage": "sourceImage",
  "targetImage": "targetImage"
}
'

shell

Request Body Example

{
  "sourceImage": "sourceImage",
  "targetImage": "targetImage"
}

json

GET

https://api.botskyc.com

/liveness/session/{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.

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/liveness/session/{sessionId}/results

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

shell

Document Forensics Health and Monitoring

Create Liveness Session

POST

https://api.botskyc.com

/liveness/session

Create Liveness Session › 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.

Create Liveness Session › Request Body

Liveness session creation request

client_session_id

string

Optional client-provided session identifier for tracking

object

Optional settings for the liveness session

Create Liveness Session › Responses

Liveness session created successfully

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)

Compare Faces

POST

https://api.botskyc.com

/liveness/compare-faces

Compare two face images and return similarity score (0-100) and match determination. Supports ID photo to selfie comparison with configurable threshold. Input: Base64-encoded images.

Compare Faces › 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.

Compare Faces › Request Body

Face comparison request with source and target images (Base64 encoded)

sourceImage

string

targetImage

string

Compare Faces › Responses

Face comparison completed successfully

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