The client application initiates a liveness detection session by making a request to the backend. The system generates a unique session identifier (sessionId), which is essential for tracking the session. This step ensures that the user is physically present and interacting with the system in real time.
Curl Request
curl --location 'https://staging.cypherface.com/start-liveness-session/' \
--header 'authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjeXBoZXJGYWNlSWQiOiI2Nzg4YTU0Njk3ZmQxNjQzNjA5YWMwNGIiLCJ4QXBpS2V5IjoiMWI4YTIyYjgtNmI2NC00YWJhLTlhNWMtNWFiNGNhOWM5NDQ5IiwiaWF0IjoxNzQwMDYyMTIwLCJleHAiOjE3NDAyMzQ5MjB9.fTmqwMCElXGICO34WyNzNJGYnQoMsxWNkqAVDra7h4A' \
--header 'Content-Type: application/json' \
--header 'Cookie: connect.sid=s%3AyoqwqQtJPuetxSVZLt9_3cikxJ6eSZO-.RDMRaaGKPjP%2F7f6E1pJeiOCPXiu61fEP8J8PwHvgW%2BY' \
--data '{
"userId":"67b72c82732237217a7e1824"
}'
Liveness Detection Process
To start the liveness detection process, the client application must send a POST request to the endpoint /start-liveness-session/. This request will initiate a new session and return a unique sessionId.
Request
Endpoint: POST /start-liveness-session/
Response
On success, the API will return a JSON response containing the session ID:
{
"sessionId": "1234567890abcdef"
}
Usage
The generated sessionId must be stored and used for subsequent requests related to liveness detection, such as face capture and validation.