Authenticate user by comparing base64 image from request and user's existing face template. In case of One to one authentication, user is first found in DB by hint from request. At least one of criteria parameter must be sent in request. In case of One to N authentication, hint is not used. In case face doesn't match error response is returned.
API reference, Onboarding authentication
Authentication with face/selfie image
POST
https://demo-api.incodesmile.com/omni/onboarding-authentications/authenticate/third-partyHeaders
Request body
application/json
Image of user's face represented in base64.
Face coordinates
Left eye coordinates for X
Left eye coordinates for Y
Right eye coordinates for X
Right eye coordinates for Y
Left mouth coordinates for X. Note: the field is deprecated, use leftMouthX instead
Left mouth coordinates for X
Left mouth coordinates for Y. Note: the field is deprecated, use leftMouthY instead
Left mouth coordinates for Y
Right mouth coordinates for X
Right mouth coordinates for Y
Nose coordinates for X
Nose coordinates for Y
X coordinate of face rectangle.
Y coordinate of face rectangle.
Width of face rectangle.
Height of face rectangle.
Customer hint. Possible hints are: customer id, email, phone number...
Id of recording used in spoof detection.
Responses
Response body (application/json)
Authentication status: FAIL/PASS.
enum
PASSFAILChecked only if configured in the session flow. Shows remaining number of attempts, and maximum number of attempts allowed.
Maximum number of attempts to capture a photo.
Number of remaining attempts to capture a photo.
Id of matched candidate.
Error name and description pair. Possible error names are: INACTIVE_SESSION, NONEXISTENT_CUSTOMER, LENSES_DETECTED, FACE_MASK_DETECTED, HEAD_COVER_DETECTED, CLOSED_EYES_DETECTED, FACE_TOO_DARK, SPOOF_ATTEMPT_DETECTED, USER_IS_NOT_RECOGNIZED, SELFIE_IMAGE_LOW_QUALITY, MULTIPLE_FACES_DETECTED, HINT_NOT_PROVIDED, FACE_NOT_FOUND, FACE_CROPPING_FAILED, FACE_TOO_SMALL, FACE_TOO_BLURRY, BAD_PHOTO_QUALITY, PROCESSING_ERROR, BAD_REQUEST