Face liveness detection is a technique used in facial recognition systems to determine whether a face being presented to the system is real or fake. It helps prevent spoofing attacks where an attacker
Face Liveness Scanner
This structure represents the output of the face detection function.
Feature
Type
Name
Face rectangle
int
x1, y1, x2, y2
Liveness score (0 ~ 1)
float
liveness
Face angles (-45 ~ 45)
float
yaw, roll, pitch
Face quality (0 ~ 1)
float
face_quality
Face luminance (0 ~ 255)
float
face_luminance
Eye distance (pixels)
float
eye_dist
Eye closure (0 ~ 1)
float
left_eye_closed, right_eye_closed
Face occlusion (0 ~ 1)
float
face_occlusion
Mouth opening (0 ~ 1)
float
mouth_opened
68 points facial landmark
float[]
landmarks_68
Face Detection
The Face SDK provides a single API for detecting faces, performing liveness detection, determining face orientation (yaw, roll, pitch), assessing face quality, detecting facial occlusion, eye closure, mouth opening, and identifying facial landmarks.
Create a new face liveness scan.
POST https://dmsworkspace-gateway-backend-int.dmsworkspace.com/face-liveness-sdk/v1/check_liveness
Request Type: form-data
Request Body
Name
Type
Description
channel*
string
Your sales channel (WEB, MOBILE, OTHER)
file*
multipart
The image to be analyzed by our IA SDK for spoofing detection
reference*
string
Custom value to identify scans later on the platform (Contract Number, etc)
General Overview
When submitting documents for identity verification through our platform, the system performs a comprehensive analysis to ensure the authenticity of the identification provided. Below are explanations for the various terms and outcomes you might encounter in the analysis results:
elapsedTime: Amount of time (in seconds) taken to analyze the document.
salesChannel: Indicates the medium through which the sales transaction is initiated. For example, WEB, MOBILE, or OTHER.
eyeClosed: A boolean indicating if the eyes were detected as closed in the image.
livenessScore: A numerical value representing the liveliness detected in the image to prevent spoofing. Closer to 1 indicates higher liveness.
result: The overall conclusion of the analysis, which could be:
Spoof: Indicative of a potential spoof attempt.
No face: No face could be detected in the image provided.
Multiple face: More than one face detected, which could affect the verification process.
faces: An array of face objects detected, each object contains detailed facial analysis such as eyeDistance, faceLuminance, faceQuality, and others.
boundaryFace, notFront, occluded, small: Boolean indicators for specific conditions regarding the face position and visibility in the image. If true, they could negatively impact the verification process.
Understanding these terms and outcomes is crucial for interpreting the results correctly and taking appropriate actions based on the analysis provided.
get
Get by id
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
: OpenID Connect scope for add user roles to the access token
Path parameters
idstring · uuidRequired
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
404
Not Found
*/*
get
/v1/face-liveness/{id}
put
Update entity
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
: OpenID Connect scope for add user roles to the access token
Path parameters
idstring · uuidRequired
Body
Ocr Face Liveness Scan model
idstring · uuidOptional
companyIdstring · uuidOptional
Company Id
createdDatestring · date-timeOptional
Created Date
updatedDatestring · date-timeOptional
Updated Date
createdByIdstring · uuidOptional
Created By
updatedByIdstring · uuidOptional
Updated By
elapsedTimenumber · doubleOptional
Elapsed Time of extraction in seconds
salesChannelstringOptional
eyeClosedbooleanOptional
livenessScorenumber · doubleOptional
luminancestringOptional
mouthOpenedbooleanOptional
qualitystringOptional
resultstringOptional
boundaryFacebooleanOptional
notFrontbooleanOptional
occludedbooleanOptional
smallbooleanOptional
Responses
200
OK
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
404
Not Found
*/*
put
/v1/face-liveness/{id}
get
Get results paginated
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
: OpenID Connect scope for add user roles to the access token
