What is the Risky Faces API?
The Risky Faces API is designed to identify individuals with potential risks by matching facial images against a blacklist database. This can help businesses streamline their identity verification processes.
How do I integrate the Risky Faces API?
To integrate the API, follow these steps:
-
Obtain your X-ACCESS-TOKEN from the Websaas Platform.
-
Make a POST request to the endpoint:
https://api.advance.ai/openapi/face-recognition/v2/face-blacklist. -
Include the necessary headers and form-data parameters:
-
faceImage: Upload a valid image file.
-
imageType: Specify
PHOTO_FACEas the image type.
-
What are the image requirements for the API?
-
Format: PNG, JPG, JPEG
-
File Size: Maximum 2 MB
-
Resolution: Between 128 x 128 and 4096 x 4096
How is the API’s success determined?
The API provides a JSON response with fields like:
-
code: Status code (e.g.,
SUCCESSfor a successful check) -
recommendation: Outcome recommendation, such as
PASSorNEED_VERIFICATION -
hitCount: Number of matches in the blacklist database
-
overDueRisk and fraudRisk: Indicate potential risks associated with the face
What should I do if I receive an error response?
Errors are indicated by specific codes, such as:
-
IMAGE_INVALID_FORMAT: Check the image format and content type. -
NO_FACE_DETECTED: Ensure a clear and valid face image is uploaded. -
PARAMETER_ERROR: Verify all required parameters are correctly provided.
What charges are associated with the API?
-
Free: If the result is
PASS(no risks found). -
Pay: If the result requires verification (
NEED_VERIFICATION).
Comments
0 comments