urlscan.io logo urlscan.io
SecurityTrails logo

apidocs.lystface.com Open in urlscan Pro
52.54.68.199  Public Scan

Back to summary
URL: https://apidocs.lystface.com/
Submission: On July 03 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

 * Body
 * Headers (0)

 * Body
 * Headers (0)

 * Body
 * Headers (0)

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
Production

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Lystface API
Introduction
POST
Enroll Face
POST
Verify Face
POST
Recognize Face
POST
Gallery List
POST
Gallery Subject
POST
Compare Face
POST
Remove Subject
POST
Remove Gallery


LYSTFACE API

Lystface is a cutting-edge facial recognition API designed to verify and
authenticate individuals quickly and accurately. Our API offers a suite of
powerful functionalities to meet your facial recognition needs, including
enroll, verify, and recognize.


KEY FEATURES

   
 * Enroll: Add new faces to your database by capturing and storing facial data
   securely.
   
 * Verify: Confirm if a provided photo matches the enrolled facial data of an
   individual.
   
 * Recognize: Identify and match faces from a large dataset, providing accurate
   results in real-time.
   


USE CASES

Lystface API can be integrated into various applications, including:

   
 * Security Systems: Enhance security protocols by incorporating reliable facial
   recognition.
   
 * Access Control: Ensure authorized access to sensitive areas or information.
   
 * Identity Verification: Streamline identity verification processes for
   businesses and services.
   


GETTING STARTED

To begin using the Lystface API, follow these steps:

   
 * Sign Up: Create an account and obtain your API key.
   
 * Integration: Follow our detailed integration guides to add Lystface
   functionalities to your application.
   


TERMINOLOGY

   

 * Gallery: A collection of subjects, similar to a folder containing multiple
   files. Each gallery can hold numerous subjects.

   

 * Subject: An individual entry within a gallery, similar to a file within a
   folder, representing a person with their facial data.

   




POSTENROLL FACE

https://api.lystface.com/enroll
   
 * With help of this api user can enroll image for subject_id.
   
 * 5 faces allowded per subject.
   


REQUEST BODY

inputType- form

   
 * app_id (text): The ID of the application.
   
 * app_key (text): The key of the application.
   
 * image (file): The image to be enrolled.
   
 * gallery_name (text): The name of the gallery.
   
 * subject_id (text): The ID of the subject.
   


RESPONSE

   
 * showMessage (boolean): Indicates whether to show a message.
   
 * responseCode (integer): The code indicating the status of the response.
   
 * responseStatus (string): The status of the response.
   
 * responseMessage (string): The message associated with the response.
   
 * response (object): The response data.
   

Bodyformdata
app_id

•••••••

app_key

•••••••

image

gallery_name

cricketers

subject_id

dhoni

Example Request
Enroll Face

curl


curl --location 'https://api.lystface.com/enroll' \
--form 'app_id="•••••••"' \
--form 'app_key="•••••••"' \
--form 'image=@"/path/to/file"' \
--form 'gallery_name="cricketers"' \
--form 'subject_id="dhoni"'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers


POSTVERIFY FACE

https://api.lystface.com/verify
   
 * With the help of this api user can cheack that face belongs to same
   subject_id
   


REQUEST PARAMETERS

inputType - form

   
 * app_id (text): The ID of the application.
   
 * app_key (text): The key of the application.
   
 * image (file): The image of the subject for verification.
   
 * gallery_name (text): The name of the gallery.
   
 * subject_id (text): The ID of the subject.
   


RESPONSE

Upon successful execution, the response will include:

   
 * showMessage (boolean): Indicates whether a message should be displayed.
   
 * responseCode (integer): The code indicating the status of the response.
   
 * responseStatus (string): The status of the response.
   
 * responseMessage (string): Any message associated with the response.
   
 * response (object): The detailed response data.
   

Example response:

json


{
    "showMessage": true,
    "responseCode": 0,
    "responseStatus": "",
    "responseMessage": "",
    "response": ""
}

Bodyformdata
app_id

•••••••

app_key

•••••••

image

gallery_name

cricketers

subject_id

dhoni

Example Request
Verify Face

curl


curl --location 'https://api.lystface.com/verify' \
--form 'app_id="•••••••"' \
--form 'app_key="•••••••"' \
--form 'image=@"/path/to/file"' \
--form 'gallery_name="cricketers"' \
--form 'subject_id="dhoni"'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers


POSTRECOGNIZE FACE

https://api.lystface.com/recognize
   
 * If user enrolled the image to subject_id in the gallery_name.
   
 * With the help of this api user recognize the image. User can find image
   belong to which subject_id
   

REQUEST BODY

inputType - form

   
 * app_id (text): The ID of the application.
   
 * app_key (text): The key of the application.
   
 * gallery_name (text): The name of the gallery to search for the image.
   
 * image (file): The image file to be recognized.
   

RESPONSE

   
 * Status: 400
   
 * showMessage (boolean): Indicates whether a message should be displayed.
   
 * responseCode (integer): The code indicating the status of the response.
   
 * responseStatus (string): The status of the response.
   
 * responseMessage (string): The message associated with the response.
   
 * response (string): The response data.
   

Bodyformdata
app_id

•••••••

app_key

•••••••

gallery_name

cricketers

image

Example Request
Recognize Face

curl


curl --location 'https://api.lystface.com/recognize' \
--form 'app_id="•••••••"' \
--form 'app_key="•••••••"' \
--form 'gallery_name="cricketers"' \
--form 'image=@"/path/to/file"'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers


POSTGALLERY LIST

https://api.lystface.com/galleries-list
   
 * With the help of this api we can fetch the gallery list of the application.
   


REQUEST BODY

   
 * app_id (text, required): The ID of the application.
   
 * app_key (text, required): The key of the application.
   


RESPONSE

   
 * showMessage (boolean): Indicates whether a message should be displayed.
   
 * responseCode (integer): The code associated with the response.
   
 * responseStatus (string): The status of the response.
   
 * responseMessage (string): The message associated with the response.
   
 * response (string): The response data.
   

The last execution of this request resulted in a 400 status code, and the
response contained the above-mentioned properties.

Bodyraw (json)
json


{
    "app_id":"•••••••",
    "app_key":"•••••••"
}

Example Request
Gallery List

curl


curl --location 'https://api.lystface.com/galleries-list' \
--data '{
    "app_id":"•••••••",
    "app_key":"•••••••"
}'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers