Fingerprint reader client

Drives a USB fingerprint reader via the SladeID companion application. See Use a USB fingerprint reader for the companion-app prerequisite and install links.


import { createFingerprintReader, FingerprintReaderClient } from '@sladeid/slade-id-sdk';
 
const reader: FingerprintReaderClient = createFingerprintReader({
  getToken: () => Promise.resolve('<bearer token>'),
});

Methods

Method	Returns
`reader.status`	`ReaderStatus`
`refreshStatus()`	`Promise<ReaderStatus>`
`enroll(input)`	`Promise<EnrollmentResult>`
`verify(input)`	`Promise<VerificationResult>`
`search()`	`Promise<SearchResult>`
`testCapture(opts?)`	`Promise<TestCaptureResult>`
`createEnrollmentSession(input)`	`EnrollmentSession`
`createVerificationSession(input)`	`VerificationSession`
`createSearchSession()`	`SearchSession`
`dispose()`	`void`

Client events

connected, disconnected, device-attached, device-detached, status.

Session events

All three session types (EnrollmentSession, VerificationSession, SearchSession) emit ready, scanning, captured, and error. Sessions are single-shot; call cancel() to abort an in-flight request.