Skip to content

DPAD Service API

1. Introduction

This document includes the API description of the service provided in the FacePhi Document Presentation Attack Detection (DPAD) Service product.

2. REST API

The REST API is described in the following Swagger documentation:

The service offers this two main endpoints:

  • /api/v1/pad_diagnostic: This endpoint performs a document liveness check using a single image. Receives an image in base64 and returns a json document with the result of the evaluation and parameters related to the internal modules of the liveness flow.

  • /pad_diagnostic_both_sides: This endpoint, like the previous one, performs a liveness check of the document, but using both sides. Receives two images doc_front and doc_back and returns the result of both analysis in a json structure, adding the suffix _front or _back to the result fields.

  • /version: Return the DPAD server version.

  • /health: Return if DPAD server is running.