Voice Service API

1. Introduction

This document includes the API description of the service provided in the FacePhi Voice Service product.

2. REST API

The REST API is described in the following Swagger documentation:

• Voice Service REST API reference

The service offers this two main endpoints:

• /api/v1/enrollment: This endpoint is used to enroll a new voice. It receives one or more audio files, and returns a voice template. The voice template is a string that contains the voice biometric information. This voice template can be used to authenticate the voices in the future. The audios can be encrypted or not, and encoded in base64. The returned template is always encrypted and encoded in base64. It accepts 1 audio, or 3 to 5 audios, to perform a text independent or text dependent enrollment, respectively:

        - 1 audio for text-independent enrollment.
        - 3 to 5 audios for text-dependent enrollment.
  

• /api/v1/authentication: This endpoint is used to authenticate a voice. It receives an audio file and a voice template, and returns a boolean value that indicates if the voice belongs to the same person as the one in the voice template, and a probability that indicates the similarity between the two voices. The audio can be encrypted or not, and encoded in base64. The voice template must be encrypted and encoded in base64.