botsKYC API Gateway - Production

Schemas

LivenessSessionRequest

Request to create a new liveness verification session

client_session_id

string

Optional client-provided session ID for tracking

LivenessSessionResponse

Liveness session created successfully

session_id

string · required

status

string · enum · required

Enum values:

CREATED

IN_PROGRESS

SUCCEEDED

FAILED

EXPIRED

created_at

string · date-time · required

expires_at

string · date-time · required

LivenessVerificationResult

Result of face liveness verification

session_id

string · required

status

string · enum · required

Enum values:

SUCCEEDED

FAILED

PENDING

confidence

number · min: 0 · max: 100 · required

Liveness confidence score (0-100)

is_live

boolean · required

True if person is determined to be live (not a spoof)

reference_image

string

Base64-encoded reference image

message

string

FaceComparisonRequest

Request to compare two face images

sourceImage

string · required

Base64-encoded source image (e.g., selfie)

targetImage

string · required

Base64-encoded target image (e.g., ID photo)

FaceMatchResult

Result of face comparison

similarity

number · min: 0 · max: 100 · required

is_match

boolean · required

confidence

number · min: 0 · max: 100

threshold

number

message

string

DocumentScanRequest

Request to scan documents. Send as multipart/form-data with files.

documents

string[] · required

Document images to scan (JPEG, PNG, PDF)

VerificationResponse

Document verification response with extracted data

requestId

string

timestamp

string · date-time

status

string · enum

Enum values:

success

partial

failed

object[]

object

DocumentResult

fileName

string

category

string · enum

Enum values:

PROOF_OF_IDENTITY

PROOF_OF_ADDRESS

PROOF_OF_INCOME

BUSINESS_ENTITY

type

string

confidence

number · min: 0 · max: 1

object

Extracted fields vary by document type

Summary

totalDocuments

integer

totalFiles

integer

categories

string[]

averageConfidence

number

totalProcessingTimeMs

integer

ScreeningRequest

Request to screen a person or entity against sanctions lists

name

string · required

Full name to screen

country

string

Country code (ISO 3166-1 alpha-2)

dateOfBirth

string · date

Date of birth for better matching

entityType

string · enum

Enum values:

individual

organization

Default: individual

ScreeningResponse

Sanctions screening result

query

string

matched

boolean

matchCount

integer

riskLevel

string · enum

Enum values:

CLEAR

LOW

MEDIUM

HIGH

CRITICAL

object[]

SanctionsMatch

name

string

matchScore

number

listSource

string

entityType

string

sanctions

string[]

RiskScoreResponse

name

string

overallScore

number · min: 0 · max: 100

riskLevel

string · enum

Enum values:

LOW

MEDIUM

HIGH

CRITICAL

recommendation

string · enum

Enum values:

APPROVE

REVIEW

REJECT

object

AdverseMediaResult

query

string

hasAdverseMedia

boolean

riskLevel

string · enum

Enum values:

CLEAR

LOW

MEDIUM

HIGH

object[]

MediaArticle

title

string

source

string

date

string

summary

string

sentiment

string · enum

Enum values:

NEGATIVE

NEUTRAL

POSITIVE

ForensicsRequest

Document forensics analysis request. Send as multipart/form-data.

file

string · binary · required

Document to analyze

mode

string · enum

Enum values:

full

quick

Default: full

document_type

string · enum

Enum values:

unknown

identity

income

address

business

ForensicsResult

Document forensics analysis result

documentId

string

verdict

string · enum

Enum values:

AUTHENTIC

SUSPICIOUS

TAMPERED

INCONCLUSIVE

confidenceScore

number · min: 0 · max: 100

riskScore

number · min: 0 · max: 100

object[]

object

ForensicsFinding

type

string

severity

string · enum

Enum values:

INFO

WARNING

CRITICAL

description

string

location

string

BusinessVerifyRequest

companyName

string

Company name to verify

registrationNumber

string

CIPA registration number or UIN

BusinessVerifyResponse

verified

boolean

companyName

string

registrationNumber

string

status

string · enum

Enum values:

ACTIVE

INACTIVE

DISSOLVED

NOT_FOUND

registrationDate

string · date

companyType

string

directors

string[]

CIPASearchResponse

query

string

totalResults

integer

object[]

CIPACompanyResponse

uin

string

name

string

status

string

registrationDate

string · date

companyType

string

registeredAddress

string

directors

string[]

object[]

ErrorResponse

error

string

message

string

code

string

timestamp

string · date-time

botsKYC API Gateway - Production

Schemas

LivenessSessionRequest

Request to create a new liveness verification session

client_session_id

string

Optional client-provided session ID for tracking

LivenessSessionResponse

Liveness session created successfully

session_id

string · required

status

string · enum · required

Enum values:

CREATED

IN_PROGRESS

SUCCEEDED

FAILED

EXPIRED

created_at

string · date-time · required

expires_at

string · date-time · required

LivenessVerificationResult

Result of face liveness verification

session_id

string · required

status

string · enum · required

Enum values:

SUCCEEDED

FAILED

PENDING

confidence

number · min: 0 · max: 100 · required

Liveness confidence score (0-100)

is_live

boolean · required

True if person is determined to be live (not a spoof)

reference_image

string

Base64-encoded reference image

message

string

FaceComparisonRequest

Request to compare two face images

sourceImage

string · required

Base64-encoded source image (e.g., selfie)

targetImage

string · required

Base64-encoded target image (e.g., ID photo)

FaceMatchResult

Result of face comparison

similarity

number · min: 0 · max: 100 · required

is_match

boolean · required

confidence

number · min: 0 · max: 100

threshold

number

message

string

DocumentScanRequest

Request to scan documents. Send as multipart/form-data with files.

documents

string[] · required

Document images to scan (JPEG, PNG, PDF)

VerificationResponse

Document verification response with extracted data

requestId

string

timestamp

string · date-time

status

string · enum

Enum values:

success

partial

failed

object[]

object

DocumentResult

fileName

string

category

string · enum

Enum values:

PROOF_OF_IDENTITY

PROOF_OF_ADDRESS

PROOF_OF_INCOME

BUSINESS_ENTITY

type

string

confidence

number · min: 0 · max: 1

object

Extracted fields vary by document type

Summary

totalDocuments

integer

totalFiles

integer

categories

string[]

averageConfidence

number

totalProcessingTimeMs

integer

ScreeningRequest

Request to screen a person or entity against sanctions lists

name

string · required

Full name to screen

country

string

Country code (ISO 3166-1 alpha-2)

dateOfBirth

string · date

Date of birth for better matching

entityType

string · enum

Enum values:

individual

organization

Default: individual

ScreeningResponse

Sanctions screening result

query

string

matched

boolean

matchCount

integer

riskLevel

string · enum

Enum values:

CLEAR

LOW

MEDIUM

HIGH

CRITICAL

object[]

SanctionsMatch

name

string

matchScore

number

listSource

string

entityType

string

sanctions

string[]

RiskScoreResponse

name

string

overallScore

number · min: 0 · max: 100

riskLevel

string · enum

Enum values:

LOW

MEDIUM

HIGH

CRITICAL

recommendation

string · enum

Enum values:

APPROVE

REVIEW

REJECT

object

AdverseMediaResult

query

string

hasAdverseMedia

boolean

riskLevel

string · enum

Enum values:

CLEAR

LOW

MEDIUM

HIGH

object[]

MediaArticle

title

string

source

string

date

string

summary

string

sentiment

string · enum

Enum values:

NEGATIVE

NEUTRAL

POSITIVE

ForensicsRequest

Document forensics analysis request. Send as multipart/form-data.

file

string · binary · required

Document to analyze

mode

string · enum

Enum values:

full

quick

Default: full

document_type

string · enum

Enum values:

unknown

identity

income

address

business

ForensicsResult

Document forensics analysis result

documentId

string

verdict

string · enum

Enum values:

AUTHENTIC

SUSPICIOUS

TAMPERED

INCONCLUSIVE

confidenceScore

number · min: 0 · max: 100

riskScore

number · min: 0 · max: 100

object[]

object

ForensicsFinding

type

string

severity

string · enum

Enum values:

INFO

WARNING

CRITICAL

description

string

location

string

BusinessVerifyRequest

companyName

string

Company name to verify

registrationNumber

string

CIPA registration number or UIN

BusinessVerifyResponse

verified

boolean

companyName

string

registrationNumber

string

status

string · enum

Enum values:

ACTIVE

INACTIVE

DISSOLVED

NOT_FOUND

registrationDate

string · date

companyType

string

directors

string[]

CIPASearchResponse

query

string

totalResults

integer

object[]

CIPACompanyResponse

uin

string

name

string

status

string

registrationDate

string · date

companyType

string

registeredAddress

string

directors

string[]

object[]

ErrorResponse

error

string

message

string

code

string

timestamp

string · date-time