@digitalpersona/authentication/dist/api/docs/authentication.faceauth.md

DigitalPersona Authentication API

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@digitalpersona/authentication](./authentication.md) &gt; [FaceAuth](./authentication.faceauth.md)

## FaceAuth class

Face authentication API. Face credential supports authentication. Identification is currently not supported by the server.

<b>Signature:</b>

```typescript
export declare class FaceAuth extends Authenticator 
```

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(authService)](./authentication.faceauth.(constructor).md) |  | Constructs a new face authentication API object. |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [authenticate(identity, samples)](./authentication.faceauth.authenticate.md) |  | Authenticates the user using their face images. |
|  [identify(samples)](./authentication.faceauth.identify.md) |  | Currently face identification is not supported by the server. |