Skip to main content
POST
Detect liveness in facial image
string
required
Face image in base64 format. Base64 encoded characters in the payload must not include the MIME type. For example, if the encoded base64 characters are “image/png;base64,/9j/2wBDABQODxIP…”, then remove “image/png;base64,” and send only the encoded data “/9j/2wBDABQODxIP…”.
string
API type identifier for the liveness detection service.
number
Liveness score indicating the probability of a live person (0-100). Higher scores indicate higher confidence that the image is from a live person.
string
Unique identifier for each request, useful for tracking and debugging purposes.
string
Information message returned as part of the recognition response, providing additional context about the result.
number
Identifies the specific error for troubleshooting. Common error codes include:
  • 1016: faceImage is required
  • 1017: Fail to analyze face

Authorizations

x-api-key
string
header
required

API key essential for authentication and access control purposes, required for authorization.

Body

application/json
faceImage
string
required

Face image in base64 format. Base64 encoded characters in the payload must not include the MIME type. For example, if the encoded base64 characters are "image/png;base64,/9j/2wBDABQODxIP...", then remove "image/png;base64," and send only the encoded data "/9j/2wBDABQODxIP...".

Example:

"{{faceImage_base64}}"

Response

Everything worked as expected.

apiType
string

API type

Example:

"id_live_face"

result
object
transactionId
string

Unique identifier for each request

Example:

"e0nvom3caiis7"