API Reference

API Workflow Documentation

The API workflow involves a series of steps, starting from merchant registration to advanced face verification. Below is the detailed flow and API endpoints for each step.

Workflow Steps

  1. Merchant Registration
  2. API Key Creation and Retrieval of Access Token
  3. User Registration
  4. Image Upload
  5. Advanced Face Liveness
  6. Face Match

API Workflow Diagram

Merchant Registration API Key Creation Access Token User Registration Image Upload Advanced Face Liveness Face Matching

API Endpoints

Action Endpoint Description
Obtain API Key https://staging.cypherface.com/merchant-api-key/ Create or retrieve an API key for merchant access.
Access Token https://staging.cypherface.com/api/access-token/ Retrieve an access token for secure API access.
Refresh Token https://staging.cypherface.com/api/refresh-token/ Refresh the access token when it expires.
Generate Upload URL https://staging.cypherface.com/api/upload/generate-url/ Generates a secure URL to upload user images.
Advanced Face Liveness https://staging.cypherface.com/api/face-liveness/start/ Initiates face liveness detection to verify a live user.
Face Matching https://staging.cypherface.com/check-liveness/ Compares the live image with the uploaded image during registration.