UNPKG

@digitalpersona/authentication

Version:
31 lines (17 loc) 1.03 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@digitalpersona/authentication](./authentication.md) &gt; [FingerprintsAuth](./authentication.fingerprintsauth.md) &gt; [identify](./authentication.fingerprintsauth.identify.md) ## FingerprintsAuth.identify() method Identifies the user with their fingerprints. <b>Signature:</b> ```typescript identify(samples: BioSample[]): Promise<JSONWebToken>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | samples | <code>BioSample[]</code> | a collection of biometric samples with fingerprint scans. | <b>Returns:</b> `Promise<JSONWebToken>` a promise to return a JSON Web Token containing a claim (`crd`<!-- -->) showing the fact a fingerprint was used. Will reject if identification fails. ## Remarks If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.