Face Liveness Detection

This request will execute Facial Liveness Detection.

Before making the request, please ensure you meet the following prerequisites:

  1. Visit Licensing to see how to get your credentials.

  2. Please ensure that the images follows our input guidelines!

  3. We only support the following image formats: .jpeg, .jpg, .png

Checkout acceptable header values to see what values we accept for each header.

Replace domain with the domain name of your environment.

Extract Document

POST https://{domain}/api/FaceLiveness/VerifyLiveness

Headers

NameTypeDescription

Authorization*

String

You need to add the word Bearer Infront of this string when sending. Use the Above call to obtain this token.

CorrelationID

String

This value is managed by the consumer of this API. When this value is set and there is a forwarding service all facial data will be passed to the forwarding service with the CorrelationID to manage the response. This is a security option to store data on another service as the data on the consuming UI could be tampered with.

Hash

String

This value is used by the Sybrin SDKs to ensure the image is coming from the same source it was capture by.

Content-type

multipart/form-data

UseV2

Boolean

Set this to true to use new Face liveness model (version 2)

UseV3

Boolean

Set this to true to use new Face liveness model in conjunction with UseV2. (Latest version) IMPORTANT!!! This model can’t be deployed on prem yet.

Request Body

NameTypeDescription

Media

multipart/form-data

This should be an image file. Send your image as a multi form data. The media image of the document that you would like to scan for. If multiple images are supplied, only the first will be used. Make sure to follow the input guidelines.