/Verify API
Login by Face image for signup with user details api.
Base URL
Verify API End Point
The Verify API is used to authenticate a user's identity by comparing a submitted image of their face to the biometric data that was previously enrolled and stored in your application's database.
To use the Verify API, you will need to make a POST request to the API endpoint with the image of their face. The API will then compare the submitted image with the stored biometric data and return a response indicating whether the two images match or not.
The response from the Verify API will include a confidence score, which indicates the level of certainty that the submitted image and stored biometric data match. A high confidence score indicates a strong likelihood that the user's identity has been verified, while a low confidence score indicates that further verification may be required.
It is important to note that the Verify API does not store any biometric data or images. The API only compares the submitted image with the previously enrolled biometric data and returns a result based on that comparison.
To ensure the security and privacy of your users' biometric data, it is recommended to use encryption and other security measures when transmitting and storing the data.
*Image file type of png, jpeg, jpg (*Mandatory)
Error Codes
FACE_TOO_CLOSE: A distance between face and camera is too small for preprocessing issues
FACE_CLOSE_TO_BORDER: Face is too close to one or more borders. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_CROPPED: Face is cropped. May reduce the accuracy of spoofing detection because edges of face may not be seen
FACE_NOT_FOUND: Face detector can't find face on image
FACE_TOO_SMALL: Facial area is not big enough for analysis. Either interpupillary distance or face size is below the configured value.
FACE_ANGLE_TOO_LARGE: Facial out-of-plane rotation angle is extremely large
FAILED_TO_PREDICT_LANDMARKS: Landmarks prediction error
FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECT: Face detection error
FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICT: Liveness prediction error
FAILED_TO_READ_IMAGE: File decoding error
FAILED_TO_READ_MODEL: Model deserializing error
FAILED_TO_WRITE_IMAGE: File encoding error
INVALID_CONFIG: Configuration file deserializing error
INVALID_FUSE_MODE: Invalid fuse mode provided
NO_SUCH_OBJECT_IN_BUILD: Engine or backend is not supported by the build
NULLPTR Nullptr provided: TOO_MANY_FACES Too many faces detected (more than maximum faces number in configuration, one face by default)
UNKNOWN: Unhandled exception in the code
POST
https://sdkbio.faceki.com/verify
Query Parameters
Headers
Request Body
Response Parameters
You must make all your requests to the API over HTTPS and TLS 1.2, with Server Name Indication enabled. Any requests made over HTTP will fail.
Responses return JSON with a consistent structure, except downloads.
Last updated