.. _ChapterEnums:

************
Enumerations
************

Enumerations
============

AutoCaptureFeedback
^^^^^^^^^^^^^^^^^^^
Feedback provided during a capture session indicating any facial quality issues with the subject.

.. csv-table:: AutoCaptureFeedback:
  :header: "Code", "Value", "Description"
  :widths: 55, 15, 100
  :align: center

  "FACE_COMPLIANT", "0", "The subject's face was compliant."
  "NO_FACE_DETECTED", "1", "No faces were detected in the image.  The subject's face must be wholly in frame."
  "MULTIPLE_FACES_DETECTED", "2", "Multiple faces were detected in the image.  The subject must be the only face in frame."
  "INVALID_POSE", "3", "The subject's pose is too far off center.  The subject should directly face the camera."
  "FACE_TOO_FAR", "4", "The subject's face is too far away.  The subject should move closer to the camera."
  "FACE_TOO_CLOSE", "5", "The subject's face is too close.  The subject should move away from the camera."
  "FACE_ON_LEFT", "6", "The subject's face is too far to the left.  The subject should move to the center of the frame."
  "FACE_ON_RIGHT", "7", "The subject's face is too far to the right.  The subject should move to the center of the frame."
  "FACE_TOO_HIGH", "8", "The subject's face is too high.  The subject should move down towards the center of the frame."
  "FACE_TOO_LOW", "9", "The subject's face is too low.  The subject should move up towards the center of the frame."
  "INSUFFICIENT_LIGHTING", "10", "There is insufficient lighting.  The subject should move to an area with more uniform lighting."
  "LEFT_EYE_CLOSED", "11", "The subject's left eye is closed.  The subject should have both eyes open and visible to the camera."
  "RIGHT_EYE_CLOSED", "12", "The subject's right eye is closed.  The subject should have both eyes open and visible to the camera."
  "DARK_GLASSES_DETECTED", "13", "The subject is wearing dark or tinted glasss.  The subject should remove the dark or tinted glasses."

CameraOrientation
^^^^^^^^^^^^^^^^^
The device's camera orientation.

.. csv-table:: CameraOrientation:
  :header: "Code", "Value", "Description"
  :widths: 55, 15, 100
  :align: center

  "PORTRAIT", "0", "Portrait orientation - Camera is held vertically."
  "LANDSCAPE", "1", "Landscape orientation - Camera is held horizontally."

CameraPosition
^^^^^^^^^^^^^^
The position of the camera on the device.

.. csv-table:: CameraPosition:
  :header: "Code", "Value", "Description"
  :widths: 55, 15, 100
  :align: center

  "FRONT", "0", "Camera is on the front of the device.  Used for selfie captures."
  "BACK", "1", "Camera is on the back of the device.  Used for capturing other subjects."

PackageType
^^^^^^^^^^^
The type of JSON request package to send to the Face Liveness back-end.

.. csv-table:: PackageType:
  :header: "Code", "Value", "Description"
  :widths: 55, 15, 100
  :align: center

  "HIGH_USABILITY", "0", "Request focused on high usability when analyzing on the back-end."
  "BALANCED", "1", "Request focused on a balance of usability and security when analyzing on the back-end."
  "HIGH_SECURITY", "2", "Request focused on high security when analyzing on the back-end"

WorkflowProperty
^^^^^^^^^^^^^^^^
Configurable properties for Workflows.

.. csv-table:: WorkflowProperty:
  :header: "Code", "Value", "Description"
  :widths: 58, 15, 100
  :align: center

  "USERNAME", "0", "A string value used to set the Username/ID fields when communicating with Knomi S Services."
  "CAPTURE_TIMEOUT", "1", "A double value indicating the maximum duration in seconds for attempting face capture before ending the capture session."
  "CAPTURE_PROFILE", "2", "A string value used to set the capture criteria for Face Capture."

EncryptionType
^^^^^^^^^^^^^^
The type of encryption for server packages.

.. csv-table:: EncryptionType:
  :header: "Code", "Value", "Description"
  :widths: 58, 15, 100
  :align: center

  "RSA_AES_256_CBC", "1", "RSA AES-256 CBC encryption."