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
- Merchant Registration
- API Key Creation and Retrieval of Access Token
- User Registration
- Image Upload
- Advanced Face Liveness
- Face Match
API Workflow Diagram
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. |
| Liveness Check and face Matching | https://staging.cypherface.com/check-liveness/ |
Compares the live image with the uploaded image during registration. |