API Reference

The Upload Frame API enables secure transmission of image frames for liveness detection and face verification. This process is a crucial step in ensuring that the provided image belongs to a live person rather than a static or fraudulent source.

Curl Request

curl --location 'https://staging.cypherface.com/upload-frame/' \
--header 'authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjeXBoZXJGYWNlSWQiOiI2Nzg4YTU0Njk3ZmQxNjQzNjA5YWMwNGIiLCJ4QXBpS2V5IjoiMWI4YTIyYjgtNmI2NC00YWJhLTlhNWMtNWFiNGNhOWM5NDQ5IiwiaWF0IjoxNzQwMDYyMTIwLCJleHAiOjE3NDAyMzQ5MjB9.fTmqwMCElXGICO34WyNzNJGYnQoMsxWNkqAVDra7h4A' \
--header 'Cookie: connect.sid=s%3AyoqwqQtJPuetxSVZLt9_3cikxJ6eSZO-.RDMRaaGKPjP%2F7f6E1pJeiOCPXiu61fEP8J8PwHvgW%2BY' \
--form 'frame=@"OkoSjk43W/amitabh (2).jpg"' \
--form 'sessionId="a50c96fa-3a8e-46a6-a422-82b4fda7e704"'

Process Flow

  1. The client captures a frame (image) from a live camera session.
  2. The captured frame is securely transmitted to the backend using a multipart/form-data request.
  3. The backend processes the image for liveness detection, ensuring that the frame is not a spoofed attempt (e.g., printed images or videos).
  4. The backend associates the uploaded frame with an ongoing liveness session.
  5. The processed frame is utilized in subsequent face-matching and verification workflows.
Frame Upload API Documentation

Frame Upload API

The Frame Upload API allows the client application to send a captured image frame to the backend for liveness detection verification.

Request

Endpoint: POST https://staging.cypherface.com/upload-frame/

Response

{
    "success": true,
    "imageKey": "liveness-sessions/da1c0e88-d7b1-4595-9d5e-114ed2f297f3/1740473473020.jpg"
}

The uploaded frame is analyzed for liveness detection, ensuring that the face captured belongs to a live person rather than a static image or spoofing attempt.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!