The API workflow involves a series of steps, starting from merchant registration to 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
- Face Matching
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 URL for Image Upload | https://staging.cypherface.com/api/upload/generate-url/ |
Generates a URL to securely upload images to the server. |
| Face Verification | https://staging.cypherface.com/api/face/match/ |
Compares a captured image with the image uploaded during registration. |
Endpoint Descriptions
Generate URL for Image Upload
Endpoint: https://staging.cypherface.com/api/upload/generate-url/
Description: This endpoint generates a URL, enabling users to securely upload images to the server. The uploaded images can serve as either a source or target for further processing.
Face Verification API
Endpoint: https://staging.cypherface.com/api/face/match/
Description: This endpoint is used for face verification. It compares a captured image with the image uploaded during registration. A successful match returns a 200 OK response.