dikript-angular-live-face-sdk
v1.0.4
Published
A Dikript's Angular SDK for live face recognition and liveness checks.
Downloads
41
Maintainers
Readme
Dikript Angular Live Face SDK
This Angular SDK provides a component for performing live face recognition and liveness checks using Dikript's API.
Features
- Live camera feed
- Face detection
- Liveness check
- Easy integration with Angular applications
Installation
To install the Dikript Angular Live Face SDK, run the following command in your Angular project:
npm install dikript-angular-live-face-sdk
Usage
- Import the
LivenessPopupComponent
in your Angular module:
import { LivenessPopupComponent } from 'dikript-angular-live-face-sdk';
@NgModule({
// ...
imports: [LivenessPopupComponent],
// ...
})
export class YourModule { }
- Use the component in your template:
<app-liveness-popup
[apiKey]="yourApiKey"
[name]="yourAppName"
[apiUrl]="dikriptApiUrl"
(closePopup)="handleClosePopup()"
(livenessResult)="handleLivenessResult($event)"
></app-liveness-popup>
- Implement the necessary methods in your component:
export class YourComponent {
apiKey = 'your_api_key_here';
name = 'Your App Name';
apiUrl = 'https://api.dikript.com/dikript/api/v1/biometrics/livelinesscheck';
handleClosePopup() {
// Handle popup close
}
handleLivenessResult(result: any) {
// Handle liveness check result
console.log('Liveness result:', result);
}
}
API Reference
Inputs
apiKey
: Your Dikript API keyname
: Your application nameapiUrl
: The Dikript API endpoint for liveness checks
Outputs
closePopup
: Emitted when the popup is closedlivenessResult
: Emitted with the result of the liveness check
Development
To set up the project for development:
- Clone the repository
- Install dependencies:
npm install
- Start the development server:
ng serve
Building
To build the project for production:
ng build --prod
This will create a production-ready build in the dist/
folder.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Support
For support, please contact Dikript Solutions at [email protected].