Documentation

Web Service

Access the webservice at http://api.enkiface.com/com/API_KEY/

Parameters

The API accepts parameters sent through GET.

  • op (mandatory): Can be set to general, full, personality, typology. The demonstrational  data set is limited to general.
  • face_base64 (recommended): A base64 encoded string of the image.
  • face_url (alternative to face_base64): The full url of the image. The platform might not be able to access the external url so we advise using the face_base64 parameter.

Input requirements

  • The image should be in JPG or PNG format.
  • The long side should not be less than 1200 or over 3000px.
  • The face contained should occupy more more than 80% of image area.

Content requirements

  • The facial expression should be neutral
  • The person should not wear eyeglasses, hard makeup or jewelry.
  • The head height, measured from the top of the head, including the hair, to the bottom of the chin, must be between 50% and 70% of the photo’s total height.
  • Head orientation is very important in the face analysis process. A full face, directly oriented toward the camera and having both eyes opened is advised. Some angles will actually prevent EnkiFace to accurately understand the image.
  • The face must be fully-lit and there must be no distracting shadows across it.
  • There must be only one person in the photo. The system will sample only the first identified photo which is the first from left to right.

Output model

The output will look similar to this:

See the Pen EnkiFace Output Sample by Mihai D Postelnicu (@mihai-d) on CodePen.

The result set will usually be empty if an error is met:

  • error: holds the error code. If it equals zero then no error was detected.
  • fidelity: holds a score regarding analysis precision based on input quality and guidelines conformation
  • message: in case there is an error, this element will usually hold details

more about the API