API Reference

Once the liveness session is established, the captured face data is used to verify the user’s identity. The client submits the sessionId along with the user’s unique identifier (userId) to the face matching API. The system then compares the live face data against the stored reference image to determine if they belong to the same person.

Curl Request

curl --location 'http://localhost:4000/match-liveness-face/' \
--header 'authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjeXBoZXJGYWNlSWQiOiI2Nzg4YTU0Njk3ZmQxNjQzNjA5YWMwNGIiLCJ4QXBpS2V5IjoiMWI4YTIyYjgtNmI2NC00YWJhLTlhNWMtNWFiNGNhOWM5NDQ5IiwiaWF0IjoxNzQwMDYyMTIwLCJleHAiOjE3NDAyMzQ5MjB9.fTmqwMCElXGICO34WyNzNJGYnQoMsxWNkqAVDra7h4A' \
--header 'Content-Type: application/json' \
--header 'Cookie: connect.sid=s%3AwUD2AY5t-OwS3KrKqaF3Z74b7pEiHNxV.18AWfz25Dc9FTcjew3Eci3VxjRYDPcRjoitoBtl3eDU' \
--data '{
    "userId":"67b72c82732237217a7e1824",
    "sessionId":"a50c96fa-3a8e-46a6-a422-82b4fda7e704"
}'

Face Matching with Liveness Detection

Face Matching with Liveness Detection

After obtaining a sessionId from the liveness detection process, the client must send a POST request to match the liveness-detected face against the registered user.

Request

Endpoint: POST https://staging.cypherface.com/match-liveness-face/

Response

The API will return a response indicating whether the face match was successful.

{
    "match": true,
    "similarity": 99.9980697631836
}
    
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!