Skip to content

FacePhi Face Liveness Service

1. Introduction

This document includes the API description of the services provided by the FacePhi Face Liveness Service.

2. REST API

The REST API is described in the following Swagger documentation: REST API reference

Entry points available:

/api/v1/version

This endpoint returns the version of the service.

/api/v1/health

The aim of this endpoint is to ensure that the service functions properly.

/api/v1/evaluate

This endpoint is used to read information from a document image and To evaluate the user's liveness on the server, which is a necessary functionality in the digital onboarding process to prevent photo or video fraud.

Parameters meaning:

  • image: Image raw buffer encoded in base64 RFC4648.

Returning:

  • diagnostic: string

Diagnostic values:

  • "Live"
  • "NoLive"
  • "NoneBecauseBadQuality"
  • "NoneBecauseFaceTooClose"
  • "NoneBecauseFaceNotFound"
  • "NoneBecauseFaceTooSmall"
  • "NoneBecauseAngleTooLarge"
  • "NoneBecauseImageDataError"
  • "NoneBecauseInternalError"
  • "NoneBecauseImagePreprocessError"
  • "NoneBecauseTooManyFaces"
  • "NoneBecauseFaceTooCloseToBorder"
  • "NoneBecauseFaceCropped"
  • "NoneBecauseLicenseError"
  • "NoneBecauseFaceOccluded"
  • "NoneBecauseEyesClosed"

/api/v1/evaluate/token

As /api/v1/evaluate but the input is a tokenized image.

Parameters meaning:

  • tokenImage: Tokenized image encoded in base64 RFC4648..

Returning:

  • diagnostic: string