biometric

Enumerations

FaceID: 2;

Iris: 3;

None: 0;

TouchID: 1;

Property	Type	Defined in
`biometryType`	`BiometryType`
`error?`	`string`
`errorCode?`	\| `"appCancel"` \| `"authenticationFailed"` \| `"invalidContext"` \| `"notInteractive"` \| `"passcodeNotSet"` \| `"systemCancel"` \| `"userCancel"` \| `"userFallback"` \| `"biometryLockout"` \| `"biometryNotAvailable"` \| `"biometryNotEnrolled"`
`isAvailable`	`boolean`

function authenticate(reason, options?): Promise<void>

Prompts the user for authentication using the system interface (touchID, faceID or Android Iris). Rejects if the authentication fails.

import { authenticate } from "@crabnebula/taurify-api/biometric";
await authenticate('Open your wallet');

Parameter	Type	Description
`reason`	`string`
`options`?	`AuthOptions`

function checkStatus(): Promise<Status>

Checks if the biometric authentication is available.

a promise resolving to an object containing all the information about the status of the biometry.