awsliveness

Perform Liveness check and return results

@harrison-coder/awsliveness

AWS Face Liveness Detection plugin for Capacitor Apps

Installation

npm install @harrison-coder/awsliveness
npx cap sync



## API

<docgen-index>

* [`startLivenessCheck(...)`](#startlivenesscheck)
* [`checkAvailability()`](#checkavailability)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### startLivenessCheck(...)

```typescript
startLivenessCheck(options: { sessionId: string; region?: string; }) => Promise<{ success: boolean; status?: string; error?: string; referenceImage?: string; }>

| Param | Type | | ------------- | ---------------------------------------------------- | | options | { sessionId: string; region?: string; } |

Returns: Promise<{ success: boolean; status?: string; error?: string; referenceImage?: string; }>

checkAvailability()

checkAvailability() => Promise<{ available: boolean; }>

Returns: Promise<{ available: boolean; }>