API Docs · eKYC Core

Face

Face-related endpoints of the eKYC Core API: comparing, verifying liveness, detecting, indexing, searching, and otherwise working with faces found in uploaded images and videos.

The composite Mix Compare faces between 2 images endpoint lives on Customized API rather than here.

Compare facesPOST/v1/compare_faces_syncCompares the faces found in two images and returns a matched, unmatched or unsure verdict with a similarity score, plus each face's location and angle.Verify face livenessPOST/v1/verify_face_liveness_syncChecks whether the selfie images, gesture images or videos were captured from a live person, and returns an is_live verdict with a liveness score.Verify face video livenessPOST/v1/verify_face_video_liveness_syncVerifies face liveness in uploaded videos and returns an is_live verdict with a liveness score, overall and per video.Verify portraitPOST/v1/verify_portrait_sanity_syncChecks the sanity of a portrait image and returns a verdict — good, or the first quality issue found — with a confidence score.Detect facesPOST/v1/detect_faces_syncDetects the faces in an image and returns each one's bounding box, and its embedding vector when asked for.Face OTPPOST/v1/face_otpCompares a newly taken selfie against the original image and returns a matched, unmatched or unsure verdict with a similarity score, alongside a liveness verdict for the selfie.Index facesPOST/v1/index_faces_syncIndexes the face in an image into a collection so it can later be retrieved by Search faces, and returns the indexed image id.Search facesPOST/v1/search_faces_syncSearches one or more collections for faces similar to the face in an image, and returns each match with a similarity score and the metadata indexed with it.Alert facesPOST/v1/alert_faces_syncRetrieves suspect faces similar to the face in an image, each with a similarity score, together with the inquiry history recorded for that face.Verify faces suspiciousPOST/v1/verify_faces_suspiciousRetrieves the fraudsters matching the faces in an image from a defined collection, each with a similarity score and metadata, plus a summary blacklist verdict.Delete facesPOST/v1/delete_facesDeletes the given image ids out of a face collection's index and returns the id of the request.Index faces videoPOST/v1/index_faces_videoIndexes a frame from a video that passes portrait sanity into a collection, and returns the indexed image id together with the video id.