🙂Faces
This section is a collection of endpoints related to face detection and recognition operations.
Detect Faces
POST https://api.tagshelf.com/v1/2face/faces/detect
(ASYNC) Detects and returns the amount of faces found in an image file.
Headers
X-Tagshelf-Session*
string
Session Token
User-Agent*
string
User Agent
Request Body
file*
Object
Binary data representing the image file
{
"code": 200,
"result": 1
}{
"code": 400,
"result": {
"msg": "A file is required for this operation."
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Compare Faces
POST https://api.tagshelf.com/v1/2face/faces/detect
(ASYNC) Compares a selfie with a document photo. Receives both images and returns the comparison score as a result.
Headers
X-Tagshelf-Session*
string
Session Token
User-Agent*
string
User Agent
Request Body
document*
Object
Binary data representing the image file
face*
Object
Binary data representing the image file
{
"code": 200,
"result": 82.7200174331665
}{
"code": 400,
"result": {
"msg": "A file is required for this operation."
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Check Smile
POST https://api.tagshelf.com/v1/2face/faces/check-smile
(ASYNC) This endpoint performs smile liveness check on a video clip. If the person in the video is smiling returns true.
Headers
X-Tagshelf-Session*
string
Session Token
User-Agent*
string
User Agent
Request Body
clip*
Object
Binary data representing the video file
{
"code": 200,
"result": true
}{
"code": 400,
"result": {
"msg": "A file is required for this operation."
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Check Blink
POST https://api.tagshelf.com/v1/2face/faces/check-blink
(ASYNC) This endpoint performs blink liveness check on a video clip. If the person in the video is blinking returns true.
Headers
X-Tagshelf-Session*
string
Session Token
User-Agent*
string
User Agent
Request Body
clip*
Object
Binary data representing the video file
{
"code": 200,
"result": true
}{
"code": 400,
"result": {
"msg": "A file is required for this operation."
}
}{
"code": 500,
"result": {
"msg": "Invalid payload. It must contain 'faceA', 'faceB' and 'threshold'."
}
}{
"code": 403,
"result": {
"msg": "Invalid token."
}
}Last updated
Was this helpful?