Skip to main content
POST
Submit a selfie and receive a liveness verdict in the same response. The engine checks that the image shows a live person — not a printed photo, screen replay, or similar spoof — and returns a score you compare against livenessThreshold. This endpoint runs liveness only. It does not screen for duplicates or blacklists, and it does not compare two faces. Call those endpoints separately if you also need screening or a face match. A typical remote-identity check runs liveness here, then face compare against a document portrait.

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

image
string
required

Base64 data URI (for example data:image/jpeg;base64,...), or a multipart file upload when posting multipart/form-data.

livenessThreshold
number
default:70

Minimum liveness confidence as a percentage (0–100), on the same scale as livenessScore. livenessPass is true and verificationStatus is VERIFIED when the score is greater than or equal to this value. May only tighten the result, never loosen it.

Required range: 0 <= x <= 100
metadata
object

Free-form correlation data, echoed back on the response.

Response

Liveness completed. Passed, rejected, and review-needed outcomes all use HTTP 200 when the engine returns a liveness verdict.

success
boolean
required
Example:

true

message
string
required

Biometrics verification successful when liveness passed; Biometrics verification rejected when liveness failed.

data
object
required
verificationStatus
enum<string>
required

Liveness verdict.

Available options:
VERIFIED,
REVIEW_NEEDED,
REJECTED
verificationStatusCode
enum<integer>
required

3 = Verified, 2 = Review Needed, 1 = Rejected.

Available options:
3,
2,
1
transactionId
string<uuid>
required
verificationType
string
required
Example:

"biometrics_verification"

createdAt
string
required
Example:

"2026-09-14 04:12:37+0000"

metadata
object | null