Best Practice
This guide provides a clear and detailed roadmap for integrating a face identity verification system into your client application. Using intuitive icons, we'll walk you through each step to ensure your implementation is effective and user-friendly.
Capture the User's Face
User Action: The process begins when the user captures their face using the client application.
Implementation Note: Ensure your application provides clear instructions for capturing a high-quality image, considering factors like lighting and background.
Important Notes on Using the Liveness Option
FACE ID offers a Liveness feature for anti-spoofing. To use Liveness, users must take and send a proper image of their face, which includes an image quality check. Ensure that the image:
- Is at least 720 pixels in height.
- Has a maximum compression of JPEG70.
Common Image Quality Issues
Message | Description |
Face Not Found | no face image |
Face Cropped | the face image is too close to the edge or cropped |
Face Too Small | the face image is too small |
Too Many Faces | there are too many faces because other faces are included |
Face Too Close | the face image is too close to the edge or cropped |
Face Close to Border | the face image is too close to the edge or cropped |
Face Occuled | the face is covered by another object |
Face Angle | the face is rotated too much from the front. |
Below are examples of possible headshots from the table above.
Tips to Avoid Liveness Errors
- Guide users to look straight ahead.
- Ensure the face is properly centered and well-positioned.
Send the Captured Face to the Server
Client to Server Communication
Once the face is captured, the client sends the image to the face id service using a POST API call to search for the face by image.
API Guide
Perform Face ID Search
Critical Path Begins
- This is a critical part of the process where the face id service attempts to match the face with an existing face in the database.
Database Scan
- The service indexes the face and scans the database for a match.
Case 1: No Matched Face
- Service Response:"No Face matched."
- Client Action:Send a request to add the new face.
- Service Action:Index the new face (only the indexed data is stored, not the image).
- Response to Client:"Indexed FACE ID."
- Client Notifies User:"Welcome to the service."
Case 2: Matched Face
- Service Response:"Matched FACE ID."
- Client Notifies User:Inform the user that they are a registered user.
End of Critical Path
Ensure Smooth Transition
Whether a new user is added or an existing user is recognized, ensure the transition to the next steps in your application is smooth and intuitive.