Class VerID

Hierarchy

VerID

Index

Methods

Methods

authenticate

authenticate(settings: AuthenticationSessionSettings): Promise<SessionResult>

- Defined in Ver-ID.ts:244
Authenticate user

Parameters
- settings: AuthenticationSessionSettings
  
  Session settings
Returns Promise<SessionResult>

captureLiveFace

captureLiveFace(settings: LivenessDetectionSessionSettings): Promise<SessionResult>

- Defined in Ver-ID.ts:255
Capture a live face

Parameters
- settings: LivenessDetectionSessionSettings
  
  Session settings
Returns Promise<SessionResult>

compareFaces

compareFaces(face1: Face, face2: Face): Promise<FaceComparisonResult>

- Defined in Ver-ID.ts:286
Compare faces and return a result

Parameters
- face1: Face
  
  Face to compare to the other face
- face2: Face
  
  Other face to compare to the first face
Returns Promise<FaceComparisonResult>

deleteRegisteredUser

deleteRegisteredUser(userId: string): Promise<void>

- Defined in Ver-ID.ts:275
Delete user with registered faces

Parameters
- userId: string
  
  ID of the user to delete
Returns Promise<void>

detectFaceInImage

detectFaceInImage(image: string): Promise<Face>

- Defined in Ver-ID.ts:296
Detect a face in image

Parameters
- image: string
  
  (https://en.wikipedia.org/wiki/Data_URI_scheme) encoded image in which to detect a face
Returns Promise<Face>

getRegisteredUsers

getRegisteredUsers(): Promise<string[]>

- Defined in Ver-ID.ts:265
Get an array of users with registered faces

Returns Promise<string[]>

register

register(settings: RegistrationSessionSettings): Promise<SessionResult>

- Defined in Ver-ID.ts:233
Register faces for user

Parameters
- settings: RegistrationSessionSettings
  
  Session settings
Returns Promise<SessionResult>

Generated using TypeDoc